VPCs ==== This section details VPC-related Linode CLI commands. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-has-keywords .. _commands_vpcs_list: `list `_ ------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`ls` Display all VPCs on your account. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs list [-h] [--updated updated] [--subnets.updated subnets.updated] [--subnets.created subnets.created] [--subnets.id subnets.id] [--subnets.label subnets.label] [--label label] [--region region] [--created created] [--id id] [--order-by {updated,subnets.updated,subnets.created,subnets.id,subnets.label,label,region,created,id}] [--order {asc,desc}] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs list .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Filterable Attributes .. rst-class:: action-subheading-description Arguments used to define a filter for response entries. .. rst-class:: action-filterable-field-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`\-\-created` - :action-table-field-type:`str` - The date-time of VPC creation. * - :action-table-field-name:`\-\-id` - :action-table-field-type:`int` - The unique ID of the VPC. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The VPC's label, for display purposes only. * - :action-table-field-name:`\-\-region` - :action-table-field-type:`str` - The Region for the VPC. * - :action-table-field-name:`\-\-subnets.created` - :action-table-field-type:`str` - The date-time of VPC Subnet creation. * - :action-table-field-name:`\-\-subnets.id` - :action-table-field-type:`int` - The unique ID of the VPC Subnet. * - :action-table-field-name:`\-\-subnets.label` - :action-table-field-type:`str` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`\-\-subnets.updated` - :action-table-field-type:`str` - The date-time of the most recent VPC Subnet update. * - :action-table-field-name:`\-\-updated` - :action-table-field-type:`str` - The date-time of the most recent VPC update. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC creation. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`A description of my VPC.` - A written description to help distinguish the VPC. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The unique ID of the VPC. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc` - The VPC's label, for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region for the VPC. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC update. .. _commands_vpcs_list_attribute_sections_subnets: .. rst-class:: action-section-header subnets .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`subnets.created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`subnets.id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`subnets.ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`subnets.label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`subnets.linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`subnets.linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`subnets.linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. * - :action-table-field-name:`subnets.updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_view: `view `_ ------------------------------------------------------------------ Get information about a single VPC. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs view [-h] [--updated updated] [--label label] [--subnets.id subnets.id] [--subnets.created subnets.created] [--subnets.label subnets.label] [--subnets.updated subnets.updated] [--created created] [--region region] [--id id] [--order-by {updated,label,subnets.id,subnets.created,subnets.label,subnets.updated,created,region,id}] [--order {asc,desc}] vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs view $vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC creation. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`A description of my VPC.` - A written description to help distinguish the VPC. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The unique ID of the VPC. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc` - The VPC's label, for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region for the VPC. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC update. .. _commands_vpcs_view_attribute_sections_subnets: .. rst-class:: action-section-header subnets .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`subnets.created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`subnets.id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`subnets.ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`subnets.label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`subnets.linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`subnets.linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`subnets.linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. * - :action-table-field-name:`subnets.updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_create: `create `_ --------------------------------------------------------------------- Create a new VPC and optionally associated VPC Subnets. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs create [-h] [--subnets subnets] [--subnets.ipv4 ipv4] [--subnets.linodes linodes] [--subnets.linodes.interfaces interfaces] [--subnets.linodes.interfaces.active active] [--subnets.linodes.interfaces.id id] [--subnets.linodes.id id] [--subnets.label label] [--region region] [--description description] [--label label] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs create \ --description "A description of my VPC." \ --label cool-vpc \ --region us-east \ --subnets.label cool-vpc-subnet \ --subnets.ipv4 10.0.1.0/24 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-label` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc` - The VPC's label, for display purposes only. * - :action-table-field-name:`\-\-region` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region for the VPC. * - :action-table-field-name:`\-\-description` - :action-table-field-type:`str` - :action-table-field-example:`A description of my VPC.` - A written description to help distinguish the VPC. * - :action-table-field-name:`\-\-subnets` :ref:`(section) ` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - An object describing a VPC Subnet. .. _commands_vpcs_create_argument_sections_subnets: .. rst-class:: action-section-header subnets .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-subnets.ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`\-\-subnets.label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`\-\-subnets.linodes` :ref:`(section) ` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - N/A .. _commands_vpcs_create_argument_sections_subnets.linodes: .. rst-class:: action-section-header subnets.linodes .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-subnets.linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`\-\-subnets.linodes.interfaces` :ref:`(section) ` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - N/A .. _commands_vpcs_create_argument_sections_subnets.linodes.interfaces: .. rst-class:: action-section-header subnets.linodes.interfaces .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-subnets.linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`\-\-subnets.linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC creation. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`A description of my VPC.` - A written description to help distinguish the VPC. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The unique ID of the VPC. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc` - The VPC's label, for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region for the VPC. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC update. .. _commands_vpcs_create_attribute_sections_subnets: .. rst-class:: action-section-header subnets .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`subnets.created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`subnets.id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`subnets.ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`subnets.label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`subnets.linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`subnets.linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`subnets.linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. * - :action-table-field-name:`subnets.updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_update: `update `_ -------------------------------------------------------------------- Update an existing VPC. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs update [-h] [--label label] [--description description] vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs update $vpcId \ --description "A description of my VPC." --label cool-vpc .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-description` - :action-table-field-type:`str` - :action-table-field-example:`A description of my VPC.` - A written description to help distinguish the VPC. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc` - The VPC's label, for display purposes only. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC creation. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`A description of my VPC.` - A written description to help distinguish the VPC. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The unique ID of the VPC. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc` - The VPC's label, for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region for the VPC. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC update. .. _commands_vpcs_update_attribute_sections_subnets: .. rst-class:: action-section-header subnets .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`subnets.created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`subnets.id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`subnets.ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`subnets.label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`subnets.linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`subnets.linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`subnets.linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. * - :action-table-field-name:`subnets.updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_delete: `delete `_ ----------------------------------------------------------------------- Delete a single VPC and all of its Subnets. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs delete [-h] vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs delete $vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_subnet-view: `subnet-view `_ -------------------------------------------------------------------------------- Get information about a single VPC Subnet. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs subnet-view [-h] [--label label] [--id id] [--created created] [--updated updated] [--order-by {label,id,created,updated}] [--order {asc,desc}] vpcId vpcSubnetId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs subnet-view $vpcId $vpcSubnetId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. * - :action-table-field-name:`vpcSubnetId` - :action-table-field-type:`int` - The ``id`` of the VPC Subnet. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. .. _commands_vpcs_subnet-view_attribute_sections_linodes: .. rst-class:: action-section-header linodes .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_subnet-create: `subnet-create `_ ----------------------------------------------------------------------------------- Create a VPC Subnet. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs subnet-create [-h] [--label label] [--ipv4 ipv4] vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs subnet-create $vpcId \ --label cool-vpc-subnet \ --ipv4 10.0.1.0/24 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-ipv4` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`\-\-label` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. .. _commands_vpcs_subnet-create_attribute_sections_linodes: .. rst-class:: action-section-header linodes .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_subnet-update: `subnet-update `_ ---------------------------------------------------------------------------------- Update a VPC Subnet. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs subnet-update [-h] [--label label] vpcId vpcSubnetId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs subnet-update $vpcId \ --label cool-vpc-subnet .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. * - :action-table-field-name:`vpcSubnetId` - :action-table-field-type:`int` - The ``id`` of the VPC Subnet. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Arguments .. rst-class:: action-subheading-description Additional fields used to execute this request. .. rst-class:: action-argument-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. .. _commands_vpcs_subnet-update_attribute_sections_linodes: .. rst-class:: action-section-header linodes .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. _commands_vpcs_subnet-delete: `subnet-delete `_ ------------------------------------------------------------------------------------- Delete a single VPC Subnet. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs subnet-delete [-h] vpcId vpcSubnetId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs subnet-delete $vpcId $vpcSubnetId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. * - :action-table-field-name:`vpcSubnetId` - :action-table-field-type:`int` - The ``id`` of the VPC Subnet. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-has-keywords .. _commands_vpcs_subnets-list: `subnets-list `_ ---------------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`subnets-ls` Get information about all VPC Subnets associated with a VPC. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli vpcs subnets-list [-h] [--updated updated] [--created created] [--label label] [--id id] [--order-by {updated,created,label,id}] [--order {asc,desc}] vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Sample .. rst-class:: action-subheading-description Examples of how this command might be used. .. code-block:: bash linode-cli vpcs subnets-list $vpcId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Parameters .. rst-class:: action-subheading-description Positional parameters used to define the resource this command should target. .. rst-class:: action-parameter-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`vpcId` - :action-table-field-type:`int` - The ``id`` of the VPC. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Filterable Attributes .. rst-class:: action-subheading-description Arguments used to define a filter for response entries. .. rst-class:: action-filterable-field-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 98 * - Name - Type - Description * - :action-table-field-name:`\-\-created` - :action-table-field-type:`str` - The date-time of VPC Subnet creation. * - :action-table-field-name:`\-\-id` - :action-table-field-type:`int` - The unique ID of the VPC Subnet. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`\-\-updated` - :action-table-field-type:`str` - The date-time of the most recent VPC Subnet update. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. role:: action-table-field-type .. role:: action-table-field-example .. role:: action-argument-additional-details .. role:: json(code) :language: JSON .. rst-class:: action-subheading Result Attributes .. rst-class:: action-subheading-description The attributes returned by this command. .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2023-07-11T00:00:00` - The date-time of VPC Subnet creation. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`456` - The unique ID of the VPC Subnet. * - :action-table-field-name:`ipv4` - :action-table-field-type:`str` - :action-table-field-example:`10.0.1.0/24` - IPv4 range in CIDR canonical form. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`cool-vpc-subnet` - The VPC Subnet's label, for display purposes only. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2023-09-11T00:00:00` - The date-time of the most recent VPC Subnet update. .. _commands_vpcs_subnets-list_attribute_sections_linodes: .. rst-class:: action-section-header linodes .. rst-class:: action-attribute-section-table .. list-table:: :header-rows: 1 :width: 100% :widths: 1 1 1 97 * - Name - Type - Example - Description * - :action-table-field-name:`linodes.id` - :action-table-field-type:`int` - :action-table-field-example:`111` - ID of a Linode assigned to the VPC Subnet. * - :action-table-field-name:`linodes.interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`linodes.interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`421` - ID of the interface.