Linodes ======= This section details Linode-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_linodes_list: `list `_ ------------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`ls` Returns a paginated list of Linodes you have permission to view. .. 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 linodes list [-h] [--group group] [--tags [tags] ] [--id id] [--region region] [--ipv4 [ipv4] ] [--label label] [--image image] [--placement_group.label placement_group.label] [--placement_group.placement_group_type placement_group.placement_group_type] [--order-by {group,tags,id,region,ipv4,label,image,placement_group.label,placement_group.placement_group_type}] [--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 linodes 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:`\-\-group` - :action-table-field-type:`str` - A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`\-\-id` - :action-table-field-type:`int` - This Linode's ID which must be provided for all operations impacting this Linode. * - :action-table-field-name:`\-\-image` - :action-table-field-type:`str` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`\-\-ipv4` - :action-table-field-type:`[]str` - This Linode's IPv4 Addresses. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The Linode's label is for display purposes only. * - :action-table-field-name:`\-\-placement_group.label` - :action-table-field-type:`str` - The unique name set for the placement group. * - :action-table-field-name:`\-\-placement_group.placement_group_type` - :action-table-field-type:`str` - How compute instances are distributed in your placement group. * - :action-table-field-name:`\-\-region` - :action-table-field-type:`str` - This is the `region `_ where the Linode was deployed. * - :action-table-field-name:`\-\-tags` - :action-table-field-type:`[]str` - An array of tags applied to this object. .. 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:`2018-01-01T00:01:01` - When this Linode was created. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`has_user_data` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this compute instance was provisioned utilizing ``user_data`` provided via the Metadata service. * - :action-table-field-name:`host_uuid` - :action-table-field-type:`str` - :action-table-field-example:`3a3ddd59d9a7...f44de62bfec8` - The Linode's host machine, as a UUID. * - :action-table-field-name:`hypervisor` - :action-table-field-type:`str` - :action-table-field-example:`kvm` - The virtualization software powering this Linode. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - This Linode's ID which must be provided for all operations impacting this Linode. * - :action-table-field-name:`image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["203.0.113...."192.0.2.1"]` - This Linode's IPv4 Addresses. * - :action-table-field-name:`ipv6` - :action-table-field-type:`str` - :action-table-field-example:`c001:d00d::1337/128` - This Linode's IPv6 SLAAC address. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - This is the `region `_ where the Linode was deployed. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`running` - A brief description of this Linode's current state. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of tags applied to this object. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-1` - This is the `Linode type `_ that this Linode was deployed with. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Linode was last updated. * - :action-table-field-name:`watchdog_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. .. _commands_linodes_list_attribute_sections_alerts: .. rst-class:: action-section-header alerts .. 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:`alerts.cpu` - :action-table-field-type:`int` - :action-table-field-example:`180` - The percentage of CPU usage required to trigger an alert. * - :action-table-field-name:`alerts.io` - :action-table-field-type:`int` - :action-table-field-example:`10000` - The amount of disk IO operation per second required to trigger an alert. * - :action-table-field-name:`alerts.network_in` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of incoming traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.network_out` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of outbound traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.transfer_quota` - :action-table-field-type:`int` - :action-table-field-example:`80` - The percentage of network transfer that may be used before an alert is triggered. .. _commands_linodes_list_attribute_sections_backups: .. rst-class:: action-section-header backups .. 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:`backups.available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether Backups for this Linode are available for restoration. * - :action-table-field-name:`backups.enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If this Linode has the Backup service enabled. * - :action-table-field-name:`backups.last_successful` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The last successful backup date. * - :action-table-field-name:`backups.schedule.day` - :action-table-field-type:`str` - :action-table-field-example:`Saturday` - The day of the week that your Linode's weekly Backup is taken. * - :action-table-field-name:`backups.schedule.window` - :action-table-field-type:`str` - :action-table-field-example:`W22` - The window in which your backups will be taken, in UTC. .. _commands_linodes_list_attribute_sections_placement_group: .. rst-class:: action-section-header placement_group .. 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:`placement_group.id` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`placement_group.label` - :action-table-field-type:`str` - :action-table-field-example:`PG_Miami_failover` - The unique name set for the placement group. * - :action-table-field-name:`placement_group.placement_group_policy` - :action-table-field-type:`str` - :action-table-field-example:`strict` - How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - ``strict``. * - :action-table-field-name:`placement_group.placement_group_type` - :action-table-field-type:`str` - :action-table-field-example:`anti-affinity:local` - How compute instances are distributed in your placement group. .. _commands_linodes_list_attribute_sections_specs: .. rst-class:: action-section-header specs .. 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:`specs.disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The amount of storage space, in MB, this Linode has access to. * - :action-table-field-name:`specs.gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of gpus this Linode has access to. * - :action-table-field-name:`specs.memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - The amount of RAM, in MB, this Linode has access to. * - :action-table-field-name:`specs.transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The amount of network transfer this Linode is allotted each month. * - :action-table-field-name:`specs.vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of vcpus this Linode has access to. ------------ .. 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_linodes_view: `view `_ ------------------------------------------------------------------------------ Get a specific Linode by ID. .. 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 linodes view [-h] [--group group] [--tags [tags] ] [--id id] [--region region] [--ipv4 [ipv4] ] [--label label] [--placement_group.label placement_group.label] [--placement_group.placement_group_type placement_group.placement_group_type] [--image image] [--order-by {group,tags,id,region,ipv4,label,placement_group.label,placement_group.placement_group_type,image}] [--order {asc,desc}] linodeId .. 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 linodes view 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`2018-01-01T00:01:01` - When this Linode was created. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`has_user_data` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this compute instance was provisioned utilizing ``user_data`` provided via the Metadata service. * - :action-table-field-name:`host_uuid` - :action-table-field-type:`str` - :action-table-field-example:`3a3ddd59d9a7...f44de62bfec8` - The Linode's host machine, as a UUID. * - :action-table-field-name:`hypervisor` - :action-table-field-type:`str` - :action-table-field-example:`kvm` - The virtualization software powering this Linode. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - This Linode's ID which must be provided for all operations impacting this Linode. * - :action-table-field-name:`image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["203.0.113...."192.0.2.1"]` - This Linode's IPv4 Addresses. * - :action-table-field-name:`ipv6` - :action-table-field-type:`str` - :action-table-field-example:`c001:d00d::1337/128` - This Linode's IPv6 SLAAC address. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - This is the `region `_ where the Linode was deployed. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`running` - A brief description of this Linode's current state. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of tags applied to this object. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-1` - This is the `Linode type `_ that this Linode was deployed with. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Linode was last updated. * - :action-table-field-name:`watchdog_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. .. _commands_linodes_view_attribute_sections_alerts: .. rst-class:: action-section-header alerts .. 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:`alerts.cpu` - :action-table-field-type:`int` - :action-table-field-example:`180` - The percentage of CPU usage required to trigger an alert. * - :action-table-field-name:`alerts.io` - :action-table-field-type:`int` - :action-table-field-example:`10000` - The amount of disk IO operation per second required to trigger an alert. * - :action-table-field-name:`alerts.network_in` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of incoming traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.network_out` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of outbound traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.transfer_quota` - :action-table-field-type:`int` - :action-table-field-example:`80` - The percentage of network transfer that may be used before an alert is triggered. .. _commands_linodes_view_attribute_sections_backups: .. rst-class:: action-section-header backups .. 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:`backups.available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether Backups for this Linode are available for restoration. * - :action-table-field-name:`backups.enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If this Linode has the Backup service enabled. * - :action-table-field-name:`backups.last_successful` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The last successful backup date. * - :action-table-field-name:`backups.schedule.day` - :action-table-field-type:`str` - :action-table-field-example:`Saturday` - The day of the week that your Linode's weekly Backup is taken. * - :action-table-field-name:`backups.schedule.window` - :action-table-field-type:`str` - :action-table-field-example:`W22` - The window in which your backups will be taken, in UTC. .. _commands_linodes_view_attribute_sections_placement_group: .. rst-class:: action-section-header placement_group .. 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:`placement_group.id` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`placement_group.label` - :action-table-field-type:`str` - :action-table-field-example:`PG_Miami_failover` - The unique name set for the placement group. * - :action-table-field-name:`placement_group.placement_group_policy` - :action-table-field-type:`str` - :action-table-field-example:`strict` - How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - ``strict``. * - :action-table-field-name:`placement_group.placement_group_type` - :action-table-field-type:`str` - :action-table-field-example:`anti-affinity:local` - How compute instances are distributed in your placement group. .. _commands_linodes_view_attribute_sections_specs: .. rst-class:: action-section-header specs .. 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:`specs.disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The amount of storage space, in MB, this Linode has access to. * - :action-table-field-name:`specs.gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of gpus this Linode has access to. * - :action-table-field-name:`specs.memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - The amount of RAM, in MB, this Linode has access to. * - :action-table-field-name:`specs.transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The amount of network transfer this Linode is allotted each month. * - :action-table-field-name:`specs.vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of vcpus this Linode has access to. ------------ .. 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_linodes_create: `create `_ --------------------------------------------------------------------------------- Creates a Linode Instance 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 linodes create [-h] [--metadata.user_data user_data] [--stackscript_data stackscript_data] [--booted booted] [--root_pass [ROOT_PASS] ] [--authorized_users authorized_users] [--authorized_keys authorized_keys] [--image image] [--stackscript_id stackscript_id] [--label label] [--backups_enabled backups_enabled] [--type type] [--placement_group.id id] [--swap_size swap_size] [--firewall_id firewall_id] [--backup_id backup_id] [--group group] [--tags tags] [--interfaces interfaces] [--interfaces.ipv4.vpc vpc] [--interfaces.ipv4.nat_1_1 nat_1_1] [--interfaces.active active] [--interfaces.purpose purpose] [--interfaces.subnet_id subnet_id] [--interfaces.primary primary] [--interfaces.label label] [--interfaces.ipam_address ipam_address] [--interfaces.ip_ranges ip_ranges] [--region region] [--private_ip private_ip] .. 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 linodes create \ --label linode123 \ --root_pass aComplex@Password \ --booted true \ --stackscript_id 10079 \ --stackscript_data '{"gh_username": "linode"}' \ --region us-east \ --disk_encryption enabled\ --placement_group.id 528 \ --type g6-standard-2 \ --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ --authorized_users "myUser" \ --authorized_users "secondaryUser" \ --metadata.user_data "I2Nsb3VkLWNvbmZpZw==" \ --firewall_id 9000 .. 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:`\-\-region` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The `region `_ where the Linode will be located. * - :action-table-field-name:`\-\-type` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-2` - The `Linode type `_ of the Linode you are creating. * - :action-table-field-name:`\-\-authorized_keys` - :action-table-field-type:`[]str` - :action-table-field-example:`ssh-rsa AAAA_...eir-computer` - :action-argument-additional-details:`(write-only)` A list of public SSH keys that will be automatically appended to the root user's ``~/.ssh/authorized_keys`` file when deploying from an Image. * - :action-table-field-name:`\-\-authorized_users` - :action-table-field-type:`[]str` - :action-table-field-example:`myUser` - :action-argument-additional-details:`(write-only)` A list of usernames. * - :action-table-field-name:`\-\-backup_id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - A Backup ID from another Linode's available backups. * - :action-table-field-name:`\-\-backups_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - If this field is set to ``true``, the created Linode will automatically be enrolled in the Linode Backup service. * - :action-table-field-name:`\-\-booted` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(write-only)` This field defaults to ``true`` if the Linode is created with an Image or from a Backup. * - :action-table-field-name:`\-\-firewall_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The ``id`` of the Firewall to attach this Linode to upon creation. * - :action-table-field-name:`\-\-group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - :action-argument-additional-details:`(deprecated)` A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`\-\-image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`\-\-interfaces` :ref:`(section) ` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - The Network Interface to apply to this Linode's configuration profile. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`\-\-private_ip` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If true, the created Linode will have private networking enabled and assigned a private IPv4 address. * - :action-table-field-name:`\-\-root_pass` - :action-table-field-type:`str` - :action-table-field-example:`aComplexP@ssword` - :action-argument-additional-details:`(write-only)` This sets the root user's password on a newly-created Linode Disk when deploying from an Image. * - :action-table-field-name:`\-\-stackscript_data` - :action-table-field-type:`json` - :action-table-field-example:`{"gh_username": "linode"}` - This field is required only if the StackScript being deployed requires input data from the User for successful completion. * - :action-table-field-name:`\-\-stackscript_id` - :action-table-field-type:`int` - :action-table-field-example:`10079` - A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. * - :action-table-field-name:`\-\-swap_size` - :action-table-field-type:`int` - :action-table-field-example:`512` - When deploying from an Image, this field is optional, otherwise it is ignored. * - :action-table-field-name:`\-\-tags` - :action-table-field-type:`[]str` - :action-table-field-example:`example tag` - An array of tags applied to this object. * - :action-table-field-name:`\-\-metadata.user_data` - :action-table-field-type:`str` - :action-table-field-example:`I2Nsb3VkLWNv...ZGU6IHRydWU=` - Base64-encoded `cloud-config `_ data. * - :action-table-field-name:`\-\-placement_group.id` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. .. _commands_linodes_create_argument_sections_interfaces: .. rst-class:: action-section-header 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:`\-\-interfaces.purpose` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`\-\-interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`\-\-interfaces.ip_ranges` - :action-table-field-type:`json` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - :action-argument-additional-details:`(nullable)` An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`\-\-interfaces.ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - :action-argument-additional-details:`(nullable)` This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`\-\-interfaces.ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - :action-argument-additional-details:`(nullable)` The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`\-\-interfaces.ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - :action-argument-additional-details:`(nullable)` The VPC Subnet IPv4 address for this Interface. * - :action-table-field-name:`\-\-interfaces.label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - :action-argument-additional-details:`(nullable)` The name of this Interface. * - :action-table-field-name:`\-\-interfaces.primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`\-\-interfaces.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - :action-argument-additional-details:`(nullable)` The ``id`` of the VPC Subnet for this 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:`2018-01-01T00:01:01` - When this Linode was created. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`has_user_data` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this compute instance was provisioned utilizing ``user_data`` provided via the Metadata service. * - :action-table-field-name:`host_uuid` - :action-table-field-type:`str` - :action-table-field-example:`3a3ddd59d9a7...f44de62bfec8` - The Linode's host machine, as a UUID. * - :action-table-field-name:`hypervisor` - :action-table-field-type:`str` - :action-table-field-example:`kvm` - The virtualization software powering this Linode. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - This Linode's ID which must be provided for all operations impacting this Linode. * - :action-table-field-name:`image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["203.0.113...."192.0.2.1"]` - This Linode's IPv4 Addresses. * - :action-table-field-name:`ipv6` - :action-table-field-type:`str` - :action-table-field-example:`c001:d00d::1337/128` - This Linode's IPv6 SLAAC address. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - This is the `region `_ where the Linode was deployed. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`running` - A brief description of this Linode's current state. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of tags applied to this object. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-1` - This is the `Linode type `_ that this Linode was deployed with. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Linode was last updated. * - :action-table-field-name:`watchdog_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. .. _commands_linodes_create_attribute_sections_alerts: .. rst-class:: action-section-header alerts .. 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:`alerts.cpu` - :action-table-field-type:`int` - :action-table-field-example:`180` - The percentage of CPU usage required to trigger an alert. * - :action-table-field-name:`alerts.io` - :action-table-field-type:`int` - :action-table-field-example:`10000` - The amount of disk IO operation per second required to trigger an alert. * - :action-table-field-name:`alerts.network_in` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of incoming traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.network_out` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of outbound traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.transfer_quota` - :action-table-field-type:`int` - :action-table-field-example:`80` - The percentage of network transfer that may be used before an alert is triggered. .. _commands_linodes_create_attribute_sections_backups: .. rst-class:: action-section-header backups .. 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:`backups.available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether Backups for this Linode are available for restoration. * - :action-table-field-name:`backups.enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If this Linode has the Backup service enabled. * - :action-table-field-name:`backups.last_successful` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The last successful backup date. * - :action-table-field-name:`backups.schedule.day` - :action-table-field-type:`str` - :action-table-field-example:`Saturday` - The day of the week that your Linode's weekly Backup is taken. * - :action-table-field-name:`backups.schedule.window` - :action-table-field-type:`str` - :action-table-field-example:`W22` - The window in which your backups will be taken, in UTC. .. _commands_linodes_create_attribute_sections_placement_group: .. rst-class:: action-section-header placement_group .. 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:`placement_group.id` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`placement_group.label` - :action-table-field-type:`str` - :action-table-field-example:`PG_Miami_failover` - The unique name set for the placement group. * - :action-table-field-name:`placement_group.placement_group_policy` - :action-table-field-type:`str` - :action-table-field-example:`strict` - How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - ``strict``. * - :action-table-field-name:`placement_group.placement_group_type` - :action-table-field-type:`str` - :action-table-field-example:`anti-affinity:local` - How compute instances are distributed in your placement group. .. _commands_linodes_create_attribute_sections_specs: .. rst-class:: action-section-header specs .. 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:`specs.disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The amount of storage space, in MB, this Linode has access to. * - :action-table-field-name:`specs.gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of gpus this Linode has access to. * - :action-table-field-name:`specs.memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - The amount of RAM, in MB, this Linode has access to. * - :action-table-field-name:`specs.transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The amount of network transfer this Linode is allotted each month. * - :action-table-field-name:`specs.vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of vcpus this Linode has access to. ------------ .. 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_linodes_update: `update `_ -------------------------------------------------------------------------------- Updates a Linode that you have permission to ``read_write``. .. 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 linodes update [-h] [--backups.schedule.day day] [--backups.schedule.window window] [--alerts.network_in network_in] [--alerts.network_out network_out] [--alerts.io io] [--alerts.cpu cpu] [--alerts.transfer_quota transfer_quota] [--group group] [--tags tags] [--label label] [--watchdog_enabled watchdog_enabled] linodeId .. 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 linodes update 7833080 \ --label linode123 \ --backups.schedule.day "Saturday" \ --backups.schedule.window "W22" \ --alerts.cpu 180 \ --alerts.network_in 10 \ --alerts.network_out 10 \ --alerts.transfer_quota 80 \ --alerts.io 10000 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`\-\-group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - :action-argument-additional-details:`(deprecated)` A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`\-\-tags` - :action-table-field-type:`[]str` - :action-table-field-example:`example tag` - An array of tags applied to this object. * - :action-table-field-name:`\-\-watchdog_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. * - :action-table-field-name:`\-\-alerts.cpu` - :action-table-field-type:`int` - :action-table-field-example:`180` - The percentage of CPU usage required to trigger an alert. * - :action-table-field-name:`\-\-alerts.io` - :action-table-field-type:`int` - :action-table-field-example:`10000` - The amount of disk IO operation per second required to trigger an alert. * - :action-table-field-name:`\-\-alerts.network_in` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of incoming traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`\-\-alerts.network_out` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of outbound traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`\-\-alerts.transfer_quota` - :action-table-field-type:`int` - :action-table-field-example:`80` - The percentage of network transfer that may be used before an alert is triggered. * - :action-table-field-name:`\-\-backups.schedule.day` - :action-table-field-type:`str` - :action-table-field-example:`Saturday` - :action-argument-additional-details:`(nullable)` The day of the week that your Linode's weekly Backup is taken. * - :action-table-field-name:`\-\-backups.schedule.window` - :action-table-field-type:`str` - :action-table-field-example:`W22` - :action-argument-additional-details:`(nullable)` The window in which your backups will be taken, in UTC. .. 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:`2018-01-01T00:01:01` - When this Linode was created. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`has_user_data` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this compute instance was provisioned utilizing ``user_data`` provided via the Metadata service. * - :action-table-field-name:`host_uuid` - :action-table-field-type:`str` - :action-table-field-example:`3a3ddd59d9a7...f44de62bfec8` - The Linode's host machine, as a UUID. * - :action-table-field-name:`hypervisor` - :action-table-field-type:`str` - :action-table-field-example:`kvm` - The virtualization software powering this Linode. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - This Linode's ID which must be provided for all operations impacting this Linode. * - :action-table-field-name:`image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["203.0.113...."192.0.2.1"]` - This Linode's IPv4 Addresses. * - :action-table-field-name:`ipv6` - :action-table-field-type:`str` - :action-table-field-example:`c001:d00d::1337/128` - This Linode's IPv6 SLAAC address. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - This is the `region `_ where the Linode was deployed. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`running` - A brief description of this Linode's current state. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of tags applied to this object. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-1` - This is the `Linode type `_ that this Linode was deployed with. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Linode was last updated. * - :action-table-field-name:`watchdog_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. .. _commands_linodes_update_attribute_sections_alerts: .. rst-class:: action-section-header alerts .. 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:`alerts.cpu` - :action-table-field-type:`int` - :action-table-field-example:`180` - The percentage of CPU usage required to trigger an alert. * - :action-table-field-name:`alerts.io` - :action-table-field-type:`int` - :action-table-field-example:`10000` - The amount of disk IO operation per second required to trigger an alert. * - :action-table-field-name:`alerts.network_in` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of incoming traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.network_out` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of outbound traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.transfer_quota` - :action-table-field-type:`int` - :action-table-field-example:`80` - The percentage of network transfer that may be used before an alert is triggered. .. _commands_linodes_update_attribute_sections_backups: .. rst-class:: action-section-header backups .. 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:`backups.available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether Backups for this Linode are available for restoration. * - :action-table-field-name:`backups.enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If this Linode has the Backup service enabled. * - :action-table-field-name:`backups.last_successful` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The last successful backup date. * - :action-table-field-name:`backups.schedule.day` - :action-table-field-type:`str` - :action-table-field-example:`Saturday` - The day of the week that your Linode's weekly Backup is taken. * - :action-table-field-name:`backups.schedule.window` - :action-table-field-type:`str` - :action-table-field-example:`W22` - The window in which your backups will be taken, in UTC. .. _commands_linodes_update_attribute_sections_placement_group: .. rst-class:: action-section-header placement_group .. 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:`placement_group.id` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`placement_group.label` - :action-table-field-type:`str` - :action-table-field-example:`PG_Miami_failover` - The unique name set for the placement group. * - :action-table-field-name:`placement_group.placement_group_policy` - :action-table-field-type:`str` - :action-table-field-example:`strict` - How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - ``strict``. * - :action-table-field-name:`placement_group.placement_group_type` - :action-table-field-type:`str` - :action-table-field-example:`anti-affinity:local` - How compute instances are distributed in your placement group. .. _commands_linodes_update_attribute_sections_specs: .. rst-class:: action-section-header specs .. 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:`specs.disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The amount of storage space, in MB, this Linode has access to. * - :action-table-field-name:`specs.gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of gpus this Linode has access to. * - :action-table-field-name:`specs.memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - The amount of RAM, in MB, this Linode has access to. * - :action-table-field-name:`specs.transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The amount of network transfer this Linode is allotted each month. * - :action-table-field-name:`specs.vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of vcpus this Linode has access to. ------------ .. 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_linodes_delete: `delete `_ ----------------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`rm` Deletes a Linode you have permission to ``read_write``. .. 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 linodes delete [-h] linodeId .. 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 linodes delete 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. ------------ .. 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_linodes_boot: `boot `_ ------------------------------------------------------------------------------------ Boots a Linode you have permission to modify. .. 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 linodes boot [-h] [--config_id config_id] linodeId .. 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 linodes boot 123 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode to boot. .. 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:`\-\-config_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Linode Config ID to boot into. ------------ .. 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_linodes_clone: `clone `_ -------------------------------------------------------------------------------------- You can clone your Linode's existing Disks or Configuration profiles to another Linode 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 linodes clone [-h] [--placement_group.id id] [--configs configs] [--region region] [--private_ip private_ip] [--label label] [--backups_enabled backups_enabled] [--type type] [--linode_id linode_id] [--group group] [--disks disks] [--metadata.user_data user_data] linodeId .. 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 linodes clone 123 \ --linode_id 124 \ --region us-east \ --type g6-standard-2 \ --label cloned-linode \ --backups_enabled true \ --placement_group.id 528 \ --disks 25674 \ --configs 23456 \ --private_ip true \ --metadata.user_data I2Nsb3VkLWNvbmZpZw== .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to clone. .. 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:`\-\-placement_group.id` :action-table-field-required:`*` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`\-\-backups_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If this field is set to ``true``, the created Linode will automatically be enrolled in the Linode Backup service. * - :action-table-field-name:`\-\-configs` - :action-table-field-type:`[]int` - :action-table-field-example:`N/A` - An array of configuration profile IDs. * - :action-table-field-name:`\-\-disks` - :action-table-field-type:`[]int` - :action-table-field-example:`N/A` - An array of disk IDs. * - :action-table-field-name:`\-\-group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - :action-argument-additional-details:`(deprecated)` A label used to group Linodes for display. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`cloned-linode` - The label to assign this Linode when cloning to a new Linode. * - :action-table-field-name:`\-\-linode_id` - :action-table-field-type:`int` - :action-table-field-example:`124` - If an existing Linode is the target for the clone, the ID of that Linode. * - :action-table-field-name:`\-\-private_ip` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If true, the created Linode will have private networking enabled and assigned a private IPv4 address. * - :action-table-field-name:`\-\-region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - This is the Region where the Linode will be deployed. * - :action-table-field-name:`\-\-type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-2` - A Linode's Type determines what resources are available to it, including disk space, memory, and virtual cpus. * - :action-table-field-name:`\-\-metadata.user_data` - :action-table-field-type:`str` - :action-table-field-example:`I2Nsb3VkLWNv...ZGU6IHRydWU=` - Base64-encoded `cloud-config `_ data. .. 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:`2018-01-01T00:01:01` - When this Linode was created. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`has_user_data` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this compute instance was provisioned utilizing ``user_data`` provided via the Metadata service. * - :action-table-field-name:`host_uuid` - :action-table-field-type:`str` - :action-table-field-example:`3a3ddd59d9a7...f44de62bfec8` - The Linode's host machine, as a UUID. * - :action-table-field-name:`hypervisor` - :action-table-field-type:`str` - :action-table-field-example:`kvm` - The virtualization software powering this Linode. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - This Linode's ID which must be provided for all operations impacting this Linode. * - :action-table-field-name:`image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["203.0.113...."192.0.2.1"]` - This Linode's IPv4 Addresses. * - :action-table-field-name:`ipv6` - :action-table-field-type:`str` - :action-table-field-example:`c001:d00d::1337/128` - This Linode's IPv6 SLAAC address. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - This is the `region `_ where the Linode was deployed. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`running` - A brief description of this Linode's current state. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of tags applied to this object. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-1` - This is the `Linode type `_ that this Linode was deployed with. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Linode was last updated. * - :action-table-field-name:`watchdog_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. .. _commands_linodes_clone_attribute_sections_alerts: .. rst-class:: action-section-header alerts .. 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:`alerts.cpu` - :action-table-field-type:`int` - :action-table-field-example:`180` - The percentage of CPU usage required to trigger an alert. * - :action-table-field-name:`alerts.io` - :action-table-field-type:`int` - :action-table-field-example:`10000` - The amount of disk IO operation per second required to trigger an alert. * - :action-table-field-name:`alerts.network_in` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of incoming traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.network_out` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of outbound traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.transfer_quota` - :action-table-field-type:`int` - :action-table-field-example:`80` - The percentage of network transfer that may be used before an alert is triggered. .. _commands_linodes_clone_attribute_sections_backups: .. rst-class:: action-section-header backups .. 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:`backups.available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether Backups for this Linode are available for restoration. * - :action-table-field-name:`backups.enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If this Linode has the Backup service enabled. * - :action-table-field-name:`backups.last_successful` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The last successful backup date. * - :action-table-field-name:`backups.schedule.day` - :action-table-field-type:`str` - :action-table-field-example:`Saturday` - The day of the week that your Linode's weekly Backup is taken. * - :action-table-field-name:`backups.schedule.window` - :action-table-field-type:`str` - :action-table-field-example:`W22` - The window in which your backups will be taken, in UTC. .. _commands_linodes_clone_attribute_sections_placement_group: .. rst-class:: action-section-header placement_group .. 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:`placement_group.id` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`placement_group.label` - :action-table-field-type:`str` - :action-table-field-example:`PG_Miami_failover` - The unique name set for the placement group. * - :action-table-field-name:`placement_group.placement_group_policy` - :action-table-field-type:`str` - :action-table-field-example:`strict` - How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - ``strict``. * - :action-table-field-name:`placement_group.placement_group_type` - :action-table-field-type:`str` - :action-table-field-example:`anti-affinity:local` - How compute instances are distributed in your placement group. .. _commands_linodes_clone_attribute_sections_specs: .. rst-class:: action-section-header specs .. 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:`specs.disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The amount of storage space, in MB, this Linode has access to. * - :action-table-field-name:`specs.gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of gpus this Linode has access to. * - :action-table-field-name:`specs.memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - The amount of RAM, in MB, this Linode has access to. * - :action-table-field-name:`specs.transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The amount of network transfer this Linode is allotted each month. * - :action-table-field-name:`specs.vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of vcpus this Linode has access to. ------------ .. 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_linodes_migrate: `migrate `_ ------------------------------------------------------------------------------------------ Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. .. 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 linodes migrate [-h] [--region region] [--placement_group.id id] [--type type] [--upgrade upgrade] linodeId .. 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 linodes migrate 123 \ --region us-central \ --placement_group.id 528 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to migrate. .. 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:`\-\-placement_group.id` :action-table-field-required:`*` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`\-\-region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The region to which the Linode will be migrated. * - :action-table-field-name:`\-\-type` - :action-table-field-type:`str` - :action-table-field-example:`warm` - Type of migration used in moving to a new host or Linode type. * - :action-table-field-name:`\-\-upgrade` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - When initiating a cross DC migration, setting this value to true will also ensure that the Linode is upgraded to the latest generation of hardware that corresponds to your Linode's Type, if any free upgrades are available for it. ------------ .. 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_linodes_nodebalancers: `nodebalancers `_ --------------------------------------------------------------------------------------------- Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User. .. 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 linodes nodebalancers [-h] [--label label] [--region region] [--ipv4 ipv4] [--tags [tags] ] [--order-by {label,region,ipv4,tags}] [--order {asc,desc}] linodeId .. 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 linodes nodebalancers 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`\-\-ipv4` - :action-table-field-type:`str` - This NodeBalancer's public IPv4 address. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - This NodeBalancer's label. * - :action-table-field-name:`\-\-region` - :action-table-field-type:`str` - The Region where this NodeBalancer is located. * - :action-table-field-name:`\-\-tags` - :action-table-field-type:`[]str` - An array of Tags applied to this object. .. 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:`client_conn_throttle` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - Throttle connections per second. * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this NodeBalancer was created. * - :action-table-field-name:`hostname` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.1.ip...rcontent.com` - This NodeBalancer's hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`12345` - This NodeBalancer's unique ID. * - :action-table-field-name:`ipv4` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.1` - This NodeBalancer's public IPv4 address. * - :action-table-field-name:`ipv6` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - This NodeBalancer's public IPv6 address. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`balancer12345` - This NodeBalancer's label. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region where this NodeBalancer is located. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of Tags applied to this object. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-03-01T00:01:01` - When this NodeBalancer was last updated. .. _commands_linodes_nodebalancers_attribute_sections_transfer: .. rst-class:: action-section-header transfer .. 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:`transfer.in` - :action-table-field-type:`float` - :action-table-field-example:`28.9120082855225` - The total outbound transfer, in MB, used for this NodeBalancer this month. * - :action-table-field-name:`transfer.out` - :action-table-field-type:`float` - :action-table-field-example:`3.54877281188965` - The total inbound transfer, in MB, used for this NodeBalancer this month. * - :action-table-field-name:`transfer.total` - :action-table-field-type:`float` - :action-table-field-example:`32.4607810974121` - The total transfer, in MB, used by this NodeBalancer this month. ------------ .. 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_linodes_reboot: `reboot `_ ---------------------------------------------------------------------------------------- Reboots a Linode you have permission to modify. .. 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 linodes reboot [-h] [--config_id config_id] linodeId .. 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 linodes reboot 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the linode to reboot. .. 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:`\-\-config_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Linode Config ID to reboot into. ------------ .. 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_linodes_rebuild: `rebuild `_ ------------------------------------------------------------------------------------------ Rebuilds a Linode you have the ``read_write`` permission to modify. .. 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 linodes rebuild [-h] [--authorized_users authorized_users] [--root_pass [ROOT_PASS] ] [--booted booted] [--stackscript_data stackscript_data] [--metadata.user_data user_data] [--stackscript_id stackscript_id] [--image image] [--authorized_keys authorized_keys] [--type type] linodeId .. 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 linodes rebuild 123 \ --image "linode/debian9" \ --root_pass aComplex@Password \ --disk_encryption disabled \ --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ --authorized_users "myUsername" \ --authorized_users "secondaryUsername" \ --booted true \ --stackscript_id 10079 \ --stackscript_data '{"gh_username": "linode"}' \ --type "g6-standard-2" \ --metadata.userdata "I2Nsb3VkLWNvbmZpZw==" .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to rebuild. .. 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:`\-\-image` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`\-\-root_pass` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`aComplexP@ssword` - :action-argument-additional-details:`(write-only)` This sets the root user's password on a newly-created Linode Disk when deploying from an Image. * - :action-table-field-name:`\-\-authorized_keys` - :action-table-field-type:`[]str` - :action-table-field-example:`ssh-rsa AAAA_...eir-computer` - :action-argument-additional-details:`(write-only)` A list of public SSH keys that will be automatically appended to the root user's ``~/.ssh/authorized_keys`` file when deploying from an Image. * - :action-table-field-name:`\-\-authorized_users` - :action-table-field-type:`[]str` - :action-table-field-example:`myUser` - :action-argument-additional-details:`(write-only)` A list of usernames. * - :action-table-field-name:`\-\-booted` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(write-only)` This field defaults to ``true`` if the Linode is created with an Image or from a Backup. * - :action-table-field-name:`\-\-stackscript_data` - :action-table-field-type:`json` - :action-table-field-example:`{"gh_username": "linode"}` - This field is required only if the StackScript being deployed requires input data from the User for successful completion. * - :action-table-field-name:`\-\-stackscript_id` - :action-table-field-type:`int` - :action-table-field-example:`10079` - A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. * - :action-table-field-name:`\-\-type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-2` - The ID of the `Linode type `_ to resize to with this request. * - :action-table-field-name:`\-\-metadata.user_data` - :action-table-field-type:`str` - :action-table-field-example:`I2Nsb3VkLWNv...ZGU6IHRydWU=` - Base64-encoded `cloud-config `_ data. .. 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:`2018-01-01T00:01:01` - When this Linode was created. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`Linode-Group` - A deprecated property denoting a group label for this Linode. * - :action-table-field-name:`has_user_data` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this compute instance was provisioned utilizing ``user_data`` provided via the Metadata service. * - :action-table-field-name:`host_uuid` - :action-table-field-type:`str` - :action-table-field-example:`3a3ddd59d9a7...f44de62bfec8` - The Linode's host machine, as a UUID. * - :action-table-field-name:`hypervisor` - :action-table-field-type:`str` - :action-table-field-example:`kvm` - The virtualization software powering this Linode. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - This Linode's ID which must be provided for all operations impacting this Linode. * - :action-table-field-name:`image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["203.0.113...."192.0.2.1"]` - This Linode's IPv4 Addresses. * - :action-table-field-name:`ipv6` - :action-table-field-type:`str` - :action-table-field-example:`c001:d00d::1337/128` - This Linode's IPv6 SLAAC address. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - The Linode's label is for display purposes only. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - This is the `region `_ where the Linode was deployed. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`running` - A brief description of this Linode's current state. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of tags applied to this object. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-1` - This is the `Linode type `_ that this Linode was deployed with. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Linode was last updated. * - :action-table-field-name:`watchdog_enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. .. _commands_linodes_rebuild_attribute_sections_alerts: .. rst-class:: action-section-header alerts .. 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:`alerts.cpu` - :action-table-field-type:`int` - :action-table-field-example:`180` - The percentage of CPU usage required to trigger an alert. * - :action-table-field-name:`alerts.io` - :action-table-field-type:`int` - :action-table-field-example:`10000` - The amount of disk IO operation per second required to trigger an alert. * - :action-table-field-name:`alerts.network_in` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of incoming traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.network_out` - :action-table-field-type:`int` - :action-table-field-example:`10` - The amount of outbound traffic, in Mbit/s, required to trigger an alert. * - :action-table-field-name:`alerts.transfer_quota` - :action-table-field-type:`int` - :action-table-field-example:`80` - The percentage of network transfer that may be used before an alert is triggered. .. _commands_linodes_rebuild_attribute_sections_backups: .. rst-class:: action-section-header backups .. 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:`backups.available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether Backups for this Linode are available for restoration. * - :action-table-field-name:`backups.enabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If this Linode has the Backup service enabled. * - :action-table-field-name:`backups.last_successful` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The last successful backup date. * - :action-table-field-name:`backups.schedule.day` - :action-table-field-type:`str` - :action-table-field-example:`Saturday` - The day of the week that your Linode's weekly Backup is taken. * - :action-table-field-name:`backups.schedule.window` - :action-table-field-type:`str` - :action-table-field-example:`W22` - The window in which your backups will be taken, in UTC. .. _commands_linodes_rebuild_attribute_sections_placement_group: .. rst-class:: action-section-header placement_group .. 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:`placement_group.id` - :action-table-field-type:`int` - :action-table-field-example:`528` - The placement group's ID. * - :action-table-field-name:`placement_group.label` - :action-table-field-type:`str` - :action-table-field-example:`PG_Miami_failover` - The unique name set for the placement group. * - :action-table-field-name:`placement_group.placement_group_policy` - :action-table-field-type:`str` - :action-table-field-example:`strict` - How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - ``strict``. * - :action-table-field-name:`placement_group.placement_group_type` - :action-table-field-type:`str` - :action-table-field-example:`anti-affinity:local` - How compute instances are distributed in your placement group. .. _commands_linodes_rebuild_attribute_sections_specs: .. rst-class:: action-section-header specs .. 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:`specs.disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The amount of storage space, in MB, this Linode has access to. * - :action-table-field-name:`specs.gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of gpus this Linode has access to. * - :action-table-field-name:`specs.memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - The amount of RAM, in MB, this Linode has access to. * - :action-table-field-name:`specs.transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The amount of network transfer this Linode is allotted each month. * - :action-table-field-name:`specs.vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of vcpus this Linode has access to. ------------ .. 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_linodes_rescue: `rescue `_ ---------------------------------------------------------------------------------------- Rescue Mode is a safe environment for performing many system recovery and disk management tasks. .. 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 linodes rescue [-h] [--devices.sdd.volume_id volume_id] [--devices.sdd.disk_id disk_id] [--devices.sdb.disk_id disk_id] [--devices.sdb.volume_id volume_id] [--devices.sdg.volume_id volume_id] [--devices.sdg.disk_id disk_id] [--devices.sdf.volume_id volume_id] [--devices.sdf.disk_id disk_id] [--devices.sda.disk_id disk_id] [--devices.sda.volume_id volume_id] [--devices.sde.disk_id disk_id] [--devices.sde.volume_id volume_id] [--devices.sdc.disk_id disk_id] [--devices.sdc.volume_id volume_id] linodeId .. 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 linodes rescue 123 \ --devices.sda.disk_id 124458 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to rescue. .. 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:`\-\-devices.sda.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sda.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdb.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdb.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdc.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdc.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdd.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdd.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sde.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sde.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdf.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdf.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdg.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdg.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. ------------ .. 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_linodes_resize: `resize `_ ---------------------------------------------------------------------------------------- Resizes a Linode you have the ``read_write`` permission to a different Type. .. 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 linodes resize [-h] [--migration_type migration_type] [--type type] [--allow_auto_disk_resize allow_auto_disk_resize] linodeId .. 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 linodes resize 123 \ --type g6-standard-2 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to resize. .. 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:`\-\-type` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-2` - The ID representing the Linode Type. * - :action-table-field-name:`\-\-allow_auto_disk_resize` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically resize disks when resizing a Linode. * - :action-table-field-name:`\-\-migration_type` - :action-table-field-type:`str` - :action-table-field-example:`warm` - Type of migration used in moving to a new host or Linode type. ------------ .. 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_linodes_shutdown: `shutdown `_ -------------------------------------------------------------------------------------------- Shuts down a Linode you have permission to modify. .. 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 linodes shutdown [-h] linodeId .. 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 linodes shutdown 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to shutdown. ------------ .. 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_linodes_snapshot: `snapshot `_ ---------------------------------------------------------------------------- Creates a snapshot backup of a Linode. .. 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 linodes snapshot [-h] [--label label] linodeId .. 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 linodes snapshot 123 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode the backups belong to. .. 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:`SnapshotLabel` - The label for the new snapshot. .. 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:`available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this Backup is available for restoration. * - :action-table-field-name:`configs` - :action-table-field-type:`[]str` - :action-table-field-example:`"My Debian 9 Config"` - A list of the labels of the Configuration profiles that are part of the Backup. * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup was taken. * - :action-table-field-name:`finished` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup completed. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123456` - The unique ID of this Backup. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Webserver-Backup-2018` - A label for Backups that are of type ``snapshot``. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`successful` - The current state of a specific Backup. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`snapshot` - This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup was most recently updated. .. _commands_linodes_snapshot_attribute_sections_disks: .. rst-class:: action-section-header disks .. 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:`disks.filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`disks.label` - :action-table-field-type:`str` - :action-table-field-example:`My Debian 9 Disk` - N/A * - :action-table-field-name:`disks.size` - :action-table-field-type:`int` - :action-table-field-example:`9001` - N/A ------------ .. 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_linodes_types: `types `_ ---------------------------------------------------------------------------- Returns collection of Linode Types, including pricing and specifications for each Type. .. 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 linodes types [-h] [--network_out network_out] [--memory memory] [--disk disk] [--class class] [--gpus gpus] [--vcpus vcpus] [--transfer transfer] [--label label] [--order-by {network_out,memory,disk,class,gpus,vcpus,transfer,label}] [--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 linodes types .. 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:`\-\-class` - :action-table-field-type:`str` - The class of the Linode Type. * - :action-table-field-name:`\-\-disk` - :action-table-field-type:`int` - The Disk size, in MB, of the Linode Type. * - :action-table-field-name:`\-\-gpus` - :action-table-field-type:`int` - The number of GPUs this Linode Type offers. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The Linode Type's label is for display purposes only. * - :action-table-field-name:`\-\-memory` - :action-table-field-type:`int` - Amount of RAM included in this Linode Type. * - :action-table-field-name:`\-\-network_out` - :action-table-field-type:`int` - The Mbits outbound bandwidth allocation. * - :action-table-field-name:`\-\-transfer` - :action-table-field-type:`int` - The monthly outbound transfer amount, in MB. * - :action-table-field-name:`\-\-vcpus` - :action-table-field-type:`int` - The number of VCPU cores this Linode Type offers. .. 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:`class` - :action-table-field-type:`str` - :action-table-field-example:`standard` - The class of the Linode Type. * - :action-table-field-name:`disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The Disk size, in MB, of the Linode Type. * - :action-table-field-name:`gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of GPUs this Linode Type offers. * - :action-table-field-name:`id` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-2` - The ID representing the Linode Type. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Linode 4GB` - The Linode Type's label is for display purposes only. * - :action-table-field-name:`memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - Amount of RAM included in this Linode Type. * - :action-table-field-name:`network_out` - :action-table-field-type:`int` - :action-table-field-example:`1000` - The Mbits outbound bandwidth allocation. * - :action-table-field-name:`successor` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The Linode Type that a `mutate `_ will upgrade to for a Linode of this type. * - :action-table-field-name:`transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The monthly outbound transfer amount, in MB. * - :action-table-field-name:`vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of VCPU cores this Linode Type offers. .. _commands_linodes_types_attribute_sections_addons: .. rst-class:: action-section-header addons .. 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:`addons.backups.price.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.008` - The cost (in US dollars) per hour to add Backups service. * - :action-table-field-name:`addons.backups.price.monthly` - :action-table-field-type:`float` - :action-table-field-example:`5` - The cost (in US dollars) per month to add Backups service. * - :action-table-field-name:`addons.backups.region_prices.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.0096` - Cost (in US dollars) per hour to add Backups service in this Region. * - :action-table-field-name:`addons.backups.region_prices.id` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region ID for these prices. * - :action-table-field-name:`addons.backups.region_prices.monthly` - :action-table-field-type:`float` - :action-table-field-example:`6` - Cost (in US dollars) per month to add Backups service in this Region. .. _commands_linodes_types_attribute_sections_price: .. rst-class:: action-section-header price .. 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:`price.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.03` - Cost (in US dollars) per hour. * - :action-table-field-name:`price.monthly` - :action-table-field-type:`float` - :action-table-field-example:`20` - Cost (in US dollars) per month. .. _commands_linodes_types_attribute_sections_region_prices: .. rst-class:: action-section-header region_prices .. 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:`region_prices.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.036` - Cost (in US dollars) per hour for this Region. * - :action-table-field-name:`region_prices.id` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region ID for these prices. * - :action-table-field-name:`region_prices.monthly` - :action-table-field-type:`float` - :action-table-field-example:`24` - Cost (in US dollars) per month for this Region. ------------ .. 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_linodes_upgrade: `upgrade `_ ----------------------------------------------------------------------------------------- Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation. .. 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 linodes upgrade [-h] [--allow_auto_disk_resize allow_auto_disk_resize] linodeId .. 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 linodes upgrade 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to mutate. .. 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:`\-\-allow_auto_disk_resize` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically resize disks when resizing a Linode. ------------ .. 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_linodes_volumes: `volumes `_ -------------------------------------------------------------------------------- View Block Storage Volumes attached to this Linode. .. 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 linodes volumes [-h] [--tags [tags] ] [--label label] [--order-by {tags,label}] [--order {asc,desc}] linodeId .. 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 linode volumes 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`\-\-label` - :action-table-field-type:`str` - The Volume's label is for display purposes only. * - :action-table-field-name:`\-\-tags` - :action-table-field-type:`[]str` - An array of Tags applied to this object. .. 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:`2018-01-01T00:01:01` - When this Volume was created. * - :action-table-field-name:`filesystem_path` - :action-table-field-type:`str` - :action-table-field-example:`/dev/disk/by-...me_my-volume` - The full filesystem path for the Volume based on the Volume's label. * - :action-table-field-name:`hardware_type` - :action-table-field-type:`str` - :action-table-field-example:`nvme` - The storage type of this Volume. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`12345` - The unique ID of this Volume. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`my-volume` - The Volume's label is for display purposes only. * - :action-table-field-name:`linode_id` - :action-table-field-type:`int` - :action-table-field-example:`12346` - If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here. * - :action-table-field-name:`linode_label` - :action-table-field-type:`str` - :action-table-field-example:`linode123` - If a Volume is attached to a specific Linode, the label of that Linode will be displayed here. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The unique ID of this Region. * - :action-table-field-name:`size` - :action-table-field-type:`int` - :action-table-field-example:`30` - The Volume's size, in GiB. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - The current status of the volume. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of Tags applied to this object. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Volume was last updated. ------------ .. 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_linodes_backup-view: `backup-view `_ ---------------------------------------------------------------------------- Returns information about a Backup. .. 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 linodes backup-view [-h] [--order-by {}] [--order {asc,desc}] linodeId backupId .. 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 linodes backup-view 123 123456 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode the Backup belongs to. * - :action-table-field-name:`backupId` - :action-table-field-type:`int` - The ID of the Backup to look up. .. 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:`available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this Backup is available for restoration. * - :action-table-field-name:`configs` - :action-table-field-type:`[]str` - :action-table-field-example:`"My Debian 9 Config"` - A list of the labels of the Configuration profiles that are part of the Backup. * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup was taken. * - :action-table-field-name:`finished` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup completed. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123456` - The unique ID of this Backup. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Webserver-Backup-2018` - A label for Backups that are of type ``snapshot``. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`successful` - The current state of a specific Backup. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`snapshot` - This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup was most recently updated. .. _commands_linodes_backup-view_attribute_sections_disks: .. rst-class:: action-section-header disks .. 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:`disks.filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`disks.label` - :action-table-field-type:`str` - :action-table-field-example:`My Debian 9 Disk` - N/A * - :action-table-field-name:`disks.size` - :action-table-field-type:`int` - :action-table-field-example:`9001` - N/A ------------ .. 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_linodes_backup-restore: `backup-restore `_ ---------------------------------------------------------------------------------------- Restores a Linode's Backup to the specified Linode. .. 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 linodes backup-restore [-h] [--overwrite overwrite] [--linode_id linode_id] linodeId backupId .. 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 linodes backup-restore 123 123456 \ --linode_id 234 \ --overwrite true .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode that the Backup belongs to. * - :action-table-field-name:`backupId` - :action-table-field-type:`int` - The ID of the Backup to restore. .. 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:`\-\-linode_id` :action-table-field-required:`*` - :action-table-field-type:`int` - :action-table-field-example:`234` - The ID of the Linode to restore a Backup to. * - :action-table-field-name:`\-\-overwrite` - :action-table-field-type:`bool` - :action-table-field-example:`true` - If True, deletes all Disks and Configs on the target Linode before restoring. ------------ .. 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_linodes_backups-list: `backups-list `_ ------------------------------------------------------------------------------ Returns information about this Linode's available backups. .. 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 linodes backups-list [-h] [--order-by {}] [--order {asc,desc}] linodeId .. 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 linodes backups-list 123 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode the backups belong to. .. 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:`available` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this Backup is available for restoration. * - :action-table-field-name:`configs` - :action-table-field-type:`[]str` - :action-table-field-example:`"My Debian 9 Config"` - A list of the labels of the Configuration profiles that are part of the Backup. * - :action-table-field-name:`created` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup was taken. * - :action-table-field-name:`finished` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup completed. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123456` - The unique ID of this Backup. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Webserver-Backup-2018` - A label for Backups that are of type ``snapshot``. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`successful` - The current state of a specific Backup. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`snapshot` - This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-15T00:01:01` - The date the Backup was most recently updated. .. _commands_linodes_backups-list_attribute_sections_disks: .. rst-class:: action-section-header disks .. 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:`disks.filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`disks.label` - :action-table-field-type:`str` - :action-table-field-example:`My Debian 9 Disk` - N/A * - :action-table-field-name:`disks.size` - :action-table-field-type:`int` - :action-table-field-example:`9001` - N/A ------------ .. 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_linodes_backups-cancel: `backups-cancel `_ ---------------------------------------------------------------------------------------- Cancels the Backup service on the given Linode. .. 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 linodes backups-cancel [-h] linodeId .. 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 linodes backups-cancel 123 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode to cancel backup service for. ------------ .. 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_linodes_backups-enable: `backups-enable `_ ---------------------------------------------------------------------------------------- Enables backups for the specified Linode. .. 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 linodes backups-enable [-h] linodeId .. 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 linodes backups-enable 123 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode to enable backup service for. ------------ .. 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_linodes_config-view: `config-view `_ ----------------------------------------------------------------------------------- Returns information about a specific Configuration profile. .. 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 linodes config-view [-h] [--label label] [--interfaces.label interfaces.label] [--order-by {label,interfaces.label}] [--order {asc,desc}] linodeId configId .. 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 linodes config-view 123 23456 .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. .. 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:`comments` - :action-table-field-type:`str` - :action-table-field-example:`This is my main Config` - Optional field for arbitrary User comments on this Config. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`23456` - The ID of this Config. * - :action-table-field-name:`kernel` - :action-table-field-type:`str` - :action-table-field-example:`linode/latest-64bit` - A Kernel ID to boot a Linode with. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`My Config` - The Config's label is for display purposes only. * - :action-table-field-name:`memory_limit` - :action-table-field-type:`int` - :action-table-field-example:`2048` - Defaults to the total RAM of the Linode. * - :action-table-field-name:`root_device` - :action-table-field-type:`str` - :action-table-field-example:`/dev/sda` - The root device to boot. * - :action-table-field-name:`run_level` - :action-table-field-type:`str` - :action-table-field-example:`default` - Defines the state of your Linode after booting. * - :action-table-field-name:`virt_mode` - :action-table-field-type:`str` - :action-table-field-example:`paravirt` - Controls the virtualization mode. .. _commands_linodes_config-view_attribute_sections_devices: .. rst-class:: action-section-header devices .. 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:`devices.sda.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sda.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdb.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdb.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdc.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdc.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdd.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdd.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sde.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sde.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdf.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdf.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdg.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdg.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdh.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdh.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. .. _commands_linodes_config-view_attribute_sections_helpers: .. rst-class:: action-section-header helpers .. 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:`helpers.devtmpfs_automount` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Populates the /dev directory early during boot without udev. * - :action-table-field-name:`helpers.distro` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Helps maintain correct inittab/upstart console device. * - :action-table-field-name:`helpers.modules_dep` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Creates a modules dependency file for the Kernel you run. * - :action-table-field-name:`helpers.network` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically configures static networking. * - :action-table-field-name:`helpers.updatedb_disabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Disables updatedb cron job to avoid disk thrashing. .. _commands_linodes_config-view_attribute_sections_interfaces: .. rst-class:: action-section-header interfaces .. 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:`interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`interfaces.ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`interfaces.ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`interfaces.ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`interfaces.ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this Interface. * - :action-table-field-name:`interfaces.label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`interfaces.primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`interfaces.purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`interfaces.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`interfaces.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this 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_linodes_config-create: `config-create `_ ------------------------------------------------------------------------------------------ Adds a new Configuration profile to a Linode. .. 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 linodes config-create [-h] [--label label] [--helpers.network network] [--helpers.devtmpfs_automount devtmpfs_automount] [--helpers.distro distro] [--helpers.modules_dep modules_dep] [--helpers.updatedb_disabled updatedb_disabled] [--run_level run_level] [--memory_limit memory_limit] [--kernel kernel] [--comments comments] [--root_device root_device] [--interfaces interfaces] [--interfaces.purpose purpose] [--interfaces.label label] [--interfaces.ipam_address ipam_address] [--interfaces.primary primary] [--interfaces.ip_ranges ip_ranges] [--interfaces.subnet_id subnet_id] [--interfaces.ipv4.vpc vpc] [--interfaces.ipv4.nat_1_1 nat_1_1] [--interfaces.active active] [--devices.sde.volume_id volume_id] [--devices.sde.disk_id disk_id] [--devices.sda.disk_id disk_id] [--devices.sda.volume_id volume_id] [--devices.sdc.disk_id disk_id] [--devices.sdc.volume_id volume_id] [--devices.sdg.volume_id volume_id] [--devices.sdg.disk_id disk_id] [--devices.sdb.volume_id volume_id] [--devices.sdb.disk_id disk_id] [--devices.sdd.volume_id volume_id] [--devices.sdd.disk_id disk_id] [--devices.sdh.disk_id disk_id] [--devices.sdh.volume_id volume_id] [--devices.sdf.disk_id disk_id] [--devices.sdf.volume_id volume_id] [--virt_mode virt_mode] linodeId .. 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 linodes config-create 7590910 \ --label "My Config" \ --devices.sda.disk_id 123456 \ --devices.sdb.disk_id 123457 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up Configuration profiles for. .. 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:`My Config` - The Config's label is for display purposes only. * - :action-table-field-name:`\-\-comments` - :action-table-field-type:`str` - :action-table-field-example:`This is my main Config` - :action-argument-additional-details:`(nullable)` Optional field for arbitrary User comments on this Config. * - :action-table-field-name:`\-\-interfaces` :ref:`(section) ` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - The Network Interface to apply to this Linode's configuration profile. * - :action-table-field-name:`\-\-kernel` - :action-table-field-type:`str` - :action-table-field-example:`linode/latest-64bit` - A Kernel ID to boot a Linode with. * - :action-table-field-name:`\-\-memory_limit` - :action-table-field-type:`int` - :action-table-field-example:`2048` - Defaults to the total RAM of the Linode. * - :action-table-field-name:`\-\-root_device` - :action-table-field-type:`str` - :action-table-field-example:`/dev/sda` - The root device to boot. * - :action-table-field-name:`\-\-run_level` - :action-table-field-type:`str` - :action-table-field-example:`default` - Defines the state of your Linode after booting. * - :action-table-field-name:`\-\-virt_mode` - :action-table-field-type:`str` - :action-table-field-example:`paravirt` - Controls the virtualization mode. * - :action-table-field-name:`\-\-devices.sda.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sda.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdb.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdb.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdc.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdc.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdd.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdd.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sde.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sde.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdf.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdf.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdg.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdg.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdh.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdh.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-helpers.devtmpfs_automount` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Populates the /dev directory early during boot without udev. * - :action-table-field-name:`\-\-helpers.distro` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Helps maintain correct inittab/upstart console device. * - :action-table-field-name:`\-\-helpers.modules_dep` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Creates a modules dependency file for the Kernel you run. * - :action-table-field-name:`\-\-helpers.network` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically configures static networking. * - :action-table-field-name:`\-\-helpers.updatedb_disabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Disables updatedb cron job to avoid disk thrashing. .. _commands_linodes_config-create_argument_sections_interfaces: .. rst-class:: action-section-header 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:`\-\-interfaces.purpose` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`\-\-interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`\-\-interfaces.ip_ranges` - :action-table-field-type:`json` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - :action-argument-additional-details:`(nullable)` An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`\-\-interfaces.ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - :action-argument-additional-details:`(nullable)` This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`\-\-interfaces.ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - :action-argument-additional-details:`(nullable)` The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`\-\-interfaces.ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - :action-argument-additional-details:`(nullable)` The VPC Subnet IPv4 address for this Interface. * - :action-table-field-name:`\-\-interfaces.label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - :action-argument-additional-details:`(nullable)` The name of this Interface. * - :action-table-field-name:`\-\-interfaces.primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`\-\-interfaces.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - :action-argument-additional-details:`(nullable)` The ``id`` of the VPC Subnet for this 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:`comments` - :action-table-field-type:`str` - :action-table-field-example:`This is my main Config` - Optional field for arbitrary User comments on this Config. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`23456` - The ID of this Config. * - :action-table-field-name:`kernel` - :action-table-field-type:`str` - :action-table-field-example:`linode/latest-64bit` - A Kernel ID to boot a Linode with. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`My Config` - The Config's label is for display purposes only. * - :action-table-field-name:`memory_limit` - :action-table-field-type:`int` - :action-table-field-example:`2048` - Defaults to the total RAM of the Linode. * - :action-table-field-name:`root_device` - :action-table-field-type:`str` - :action-table-field-example:`/dev/sda` - The root device to boot. * - :action-table-field-name:`run_level` - :action-table-field-type:`str` - :action-table-field-example:`default` - Defines the state of your Linode after booting. * - :action-table-field-name:`virt_mode` - :action-table-field-type:`str` - :action-table-field-example:`paravirt` - Controls the virtualization mode. .. _commands_linodes_config-create_attribute_sections_devices: .. rst-class:: action-section-header devices .. 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:`devices.sda.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sda.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdb.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdb.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdc.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdc.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdd.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdd.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sde.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sde.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdf.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdf.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdg.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdg.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdh.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdh.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. .. _commands_linodes_config-create_attribute_sections_helpers: .. rst-class:: action-section-header helpers .. 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:`helpers.devtmpfs_automount` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Populates the /dev directory early during boot without udev. * - :action-table-field-name:`helpers.distro` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Helps maintain correct inittab/upstart console device. * - :action-table-field-name:`helpers.modules_dep` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Creates a modules dependency file for the Kernel you run. * - :action-table-field-name:`helpers.network` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically configures static networking. * - :action-table-field-name:`helpers.updatedb_disabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Disables updatedb cron job to avoid disk thrashing. .. _commands_linodes_config-create_attribute_sections_interfaces: .. rst-class:: action-section-header interfaces .. 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:`interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`interfaces.ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`interfaces.ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`interfaces.ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`interfaces.ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this Interface. * - :action-table-field-name:`interfaces.label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`interfaces.primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`interfaces.purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`interfaces.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`interfaces.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this 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_linodes_config-update: `config-update `_ ------------------------------------------------------------------------------------- Updates a Configuration profile. .. 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 linodes config-update [-h] [--memory_limit memory_limit] [--kernel kernel] [--label label] [--helpers.network network] [--helpers.devtmpfs_automount devtmpfs_automount] [--helpers.distro distro] [--helpers.modules_dep modules_dep] [--helpers.updatedb_disabled updatedb_disabled] [--root_device root_device] [--comments comments] [--run_level run_level] [--virt_mode virt_mode] [--interfaces interfaces] [--interfaces.active active] [--interfaces.ipv4.nat_1_1 nat_1_1] [--interfaces.ipv4.vpc vpc] [--interfaces.subnet_id subnet_id] [--interfaces.ip_ranges ip_ranges] [--interfaces.ipam_address ipam_address] [--interfaces.primary primary] [--interfaces.label label] [--interfaces.purpose purpose] [--devices.sdg.volume_id volume_id] [--devices.sdg.disk_id disk_id] [--devices.sdb.disk_id disk_id] [--devices.sdb.volume_id volume_id] [--devices.sdd.volume_id volume_id] [--devices.sdd.disk_id disk_id] [--devices.sdh.volume_id volume_id] [--devices.sdh.disk_id disk_id] [--devices.sdf.disk_id disk_id] [--devices.sdf.volume_id volume_id] [--devices.sde.volume_id volume_id] [--devices.sde.disk_id disk_id] [--devices.sda.disk_id disk_id] [--devices.sda.volume_id volume_id] [--devices.sdc.disk_id disk_id] [--devices.sdc.volume_id volume_id] linodeId configId .. 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 linodes config-update 123 23456 \ --kernel "linode/latest-64bit" \ --comments "This is my main Config" \ --memory_limit 2048 \ --run_level default \ --virt_mode paravirt \ --helpers.updatedb_disabled true \ --helpers.distro true \ --helpers.modules_dep true \ --helpers.network true \ --helpers.devtmpfs_automount false \ --label "My Config" \ --devices.sda.disk_id 123456 \ --devices.sdb.disk_id 123457 .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. .. 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:`\-\-comments` - :action-table-field-type:`str` - :action-table-field-example:`This is my main Config` - :action-argument-additional-details:`(nullable)` Optional field for arbitrary User comments on this Config. * - :action-table-field-name:`\-\-interfaces` :ref:`(section) ` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - The Network Interface to apply to this Linode's configuration profile. * - :action-table-field-name:`\-\-kernel` - :action-table-field-type:`str` - :action-table-field-example:`linode/latest-64bit` - A Kernel ID to boot a Linode with. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`My Config` - The Config's label is for display purposes only. * - :action-table-field-name:`\-\-memory_limit` - :action-table-field-type:`int` - :action-table-field-example:`2048` - Defaults to the total RAM of the Linode. * - :action-table-field-name:`\-\-root_device` - :action-table-field-type:`str` - :action-table-field-example:`/dev/sda` - The root device to boot. * - :action-table-field-name:`\-\-run_level` - :action-table-field-type:`str` - :action-table-field-example:`default` - Defines the state of your Linode after booting. * - :action-table-field-name:`\-\-virt_mode` - :action-table-field-type:`str` - :action-table-field-example:`paravirt` - Controls the virtualization mode. * - :action-table-field-name:`\-\-devices.sda.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sda.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdb.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdb.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdc.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdc.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdd.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdd.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sde.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sde.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdf.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdf.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdg.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdg.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdh.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`\-\-devices.sdh.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`\-\-helpers.devtmpfs_automount` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Populates the /dev directory early during boot without udev. * - :action-table-field-name:`\-\-helpers.distro` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Helps maintain correct inittab/upstart console device. * - :action-table-field-name:`\-\-helpers.modules_dep` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Creates a modules dependency file for the Kernel you run. * - :action-table-field-name:`\-\-helpers.network` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically configures static networking. * - :action-table-field-name:`\-\-helpers.updatedb_disabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Disables updatedb cron job to avoid disk thrashing. .. _commands_linodes_config-update_argument_sections_interfaces: .. rst-class:: action-section-header 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:`\-\-interfaces.purpose` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`\-\-interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`\-\-interfaces.ip_ranges` - :action-table-field-type:`json` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - :action-argument-additional-details:`(nullable)` An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`\-\-interfaces.ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - :action-argument-additional-details:`(nullable)` This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`\-\-interfaces.ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - :action-argument-additional-details:`(nullable)` The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`\-\-interfaces.ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - :action-argument-additional-details:`(nullable)` The VPC Subnet IPv4 address for this Interface. * - :action-table-field-name:`\-\-interfaces.label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - :action-argument-additional-details:`(nullable)` The name of this Interface. * - :action-table-field-name:`\-\-interfaces.primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`\-\-interfaces.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - :action-argument-additional-details:`(nullable)` The ``id`` of the VPC Subnet for this 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:`comments` - :action-table-field-type:`str` - :action-table-field-example:`This is my main Config` - Optional field for arbitrary User comments on this Config. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`23456` - The ID of this Config. * - :action-table-field-name:`kernel` - :action-table-field-type:`str` - :action-table-field-example:`linode/latest-64bit` - A Kernel ID to boot a Linode with. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`My Config` - The Config's label is for display purposes only. * - :action-table-field-name:`memory_limit` - :action-table-field-type:`int` - :action-table-field-example:`2048` - Defaults to the total RAM of the Linode. * - :action-table-field-name:`root_device` - :action-table-field-type:`str` - :action-table-field-example:`/dev/sda` - The root device to boot. * - :action-table-field-name:`run_level` - :action-table-field-type:`str` - :action-table-field-example:`default` - Defines the state of your Linode after booting. * - :action-table-field-name:`virt_mode` - :action-table-field-type:`str` - :action-table-field-example:`paravirt` - Controls the virtualization mode. .. _commands_linodes_config-update_attribute_sections_devices: .. rst-class:: action-section-header devices .. 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:`devices.sda.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sda.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdb.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdb.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdc.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdc.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdd.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdd.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sde.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sde.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdf.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdf.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdg.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdg.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdh.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdh.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. .. _commands_linodes_config-update_attribute_sections_helpers: .. rst-class:: action-section-header helpers .. 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:`helpers.devtmpfs_automount` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Populates the /dev directory early during boot without udev. * - :action-table-field-name:`helpers.distro` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Helps maintain correct inittab/upstart console device. * - :action-table-field-name:`helpers.modules_dep` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Creates a modules dependency file for the Kernel you run. * - :action-table-field-name:`helpers.network` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically configures static networking. * - :action-table-field-name:`helpers.updatedb_disabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Disables updatedb cron job to avoid disk thrashing. .. _commands_linodes_config-update_attribute_sections_interfaces: .. rst-class:: action-section-header interfaces .. 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:`interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`interfaces.ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`interfaces.ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`interfaces.ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`interfaces.ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this Interface. * - :action-table-field-name:`interfaces.label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`interfaces.primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`interfaces.purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`interfaces.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`interfaces.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this 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_linodes_config-delete: `config-delete `_ ---------------------------------------------------------------------------------------- Deletes the specified Configuration profile from the specified Linode. .. 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 linodes config-delete [-h] linodeId configId .. 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 linodes config-delete 123 23456 .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. ------------ .. 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_linodes_config-interface-view: `config-interface-view `_ ------------------------------------------------------------------------------------------------------- Returns a single Configuration Profile 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 Usage .. rst-class:: action-subheading-description The format accepted by this command. .. code-block:: bash linode-cli linodes config-interface-view [-h] [--label label] [--order-by {label}] [--order {asc,desc}] linodeId configId interfaceId .. 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 linodes config-interface-view $linodeId $configId $interfaceId .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. * - :action-table-field-name:`interfaceId` - :action-table-field-type:`int` - The ``id`` of the Linode Configuration Profile 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:`active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this Interface. .. _commands_linodes_config-interface-view_attribute_sections_ipv4: .. rst-class:: action-section-header ipv4 .. 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:`ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this 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_linodes_config-interface-add: `config-interface-add `_ ------------------------------------------------------------------------------------------------------- Creates and appends a single Interface to the end of the ``interfaces`` array for an existing Configuration Profile. .. 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 linodes config-interface-add [-h] [--subnet_id subnet_id] [--label label] [--primary primary] [--ipam_address ipam_address] [--ip_ranges ip_ranges] [--purpose purpose] [--ipv4.vpc vpc] [--ipv4.nat_1_1 nat_1_1] [--active active] linodeId configId .. 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 linodes config-interface-add $linodeId $configId \ --purpose vpc \ --primary false \ --subnet_id 101 \ --ipv4.vpc "10.0.1.2" \ --ipv4.nat_1_1 "203.0.113.2" .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. .. 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:`\-\-purpose` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`\-\-active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`\-\-ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`10.0.0.64/26` - :action-argument-additional-details:`(nullable)` An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`\-\-ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - :action-argument-additional-details:`(nullable)` This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - :action-argument-additional-details:`(nullable)` The name of this Interface. * - :action-table-field-name:`\-\-primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`\-\-subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - :action-argument-additional-details:`(nullable)` The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`\-\-ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - :action-argument-additional-details:`(nullable)` The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`\-\-ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - :action-argument-additional-details:`(nullable)` The VPC Subnet IPv4 address for this 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:`active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this Interface. .. _commands_linodes_config-interface-add_attribute_sections_ipv4: .. rst-class:: action-section-header ipv4 .. 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:`ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this 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_linodes_config-interface-update: `config-interface-update `_ --------------------------------------------------------------------------------------------------------- Updates a ``vpc`` or ``public`` purpose Interface for this Configuration Profile. .. 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 linodes config-interface-update [-h] [--ip_ranges ip_ranges] [--primary primary] [--ipv4.nat_1_1 nat_1_1] [--ipv4.vpc vpc] linodeId configId interfaceId .. 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 linodes config-interface-update $linodeId $configId $interfaceId \ --primary true \ --ipv4.vpc "10.0.1.2" \ --ipv4.nat_1_1 "203.0.113.2" .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. * - :action-table-field-name:`interfaceId` - :action-table-field-type:`int` - The ``id`` of the Linode Configuration Profile 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 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:`\-\-ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`10.0.0.64/26` - :action-argument-additional-details:`(nullable)` An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`\-\-primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`\-\-ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - :action-argument-additional-details:`(nullable)` The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`\-\-ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - :action-argument-additional-details:`(nullable)` The VPC Subnet IPv4 address for this 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:`active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this Interface. .. _commands_linodes_config-interface-update_attribute_sections_ipv4: .. rst-class:: action-section-header ipv4 .. 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:`ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this 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_linodes_config-interface-delete: `config-interface-delete `_ ------------------------------------------------------------------------------------------------------------ Deletes an Interface from the Configuration Profile. .. 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 linodes config-interface-delete [-h] linodeId configId interfaceId .. 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 linodes config-delete $linodeId $configId $interfaceId .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. * - :action-table-field-name:`interfaceId` - :action-table-field-type:`int` - The ``id`` of the Linode Configuration Profile 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-has-keywords .. _commands_linodes_config-interfaces-list: `config-interfaces-list `_ --------------------------------------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`config-interfaces-ls` Returns an ordered array of all Interfaces associated with this Configuration Profile. .. 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 linodes config-interfaces-list [-h] [--label label] [--order-by {label}] [--order {asc,desc}] linodeId configId .. 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 linodes config-interfaces-list $linodeId $configId .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. .. 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:`active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this Interface. .. _commands_linodes_config-interfaces-list_attribute_sections_ipv4: .. rst-class:: action-section-header ipv4 .. 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:`ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this 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_linodes_config-interfaces-order: `config-interfaces-order `_ ----------------------------------------------------------------------------------------------------------- Reorders the existing Interfaces of a Configuration Profile. .. 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 linodes config-interfaces-order [-h] [--ids ids] linodeId configId .. 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 linodes config-interfaces-order $linodeId $configId \ --ids 101 --ids 102 --ids 103 .. 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:`linodeId` - :action-table-field-type:`int` - The ``id`` of the Linode. * - :action-table-field-name:`configId` - :action-table-field-type:`int` - The ``id`` of the Configuration Profile. .. 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:`\-\-ids` :action-table-field-required:`*` - :action-table-field-type:`[]int` - :action-table-field-example:`N/A` - An ordered array of existing Configuration Profile Interface ``id``s. ------------ .. 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_linodes_configs-list: `configs-list `_ ------------------------------------------------------------------------------------- Lists Configuration profiles associated with a Linode. .. 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 linodes configs-list [-h] [--label label] [--interfaces.label interfaces.label] [--order-by {label,interfaces.label}] [--order {asc,desc}] linodeId .. 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 linodes configs-list 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up Configuration profiles for. .. 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:`\-\-interfaces.label` - :action-table-field-type:`str` - The name of this Interface. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The Config's label is 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:`comments` - :action-table-field-type:`str` - :action-table-field-example:`This is my main Config` - Optional field for arbitrary User comments on this Config. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`23456` - The ID of this Config. * - :action-table-field-name:`kernel` - :action-table-field-type:`str` - :action-table-field-example:`linode/latest-64bit` - A Kernel ID to boot a Linode with. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`My Config` - The Config's label is for display purposes only. * - :action-table-field-name:`memory_limit` - :action-table-field-type:`int` - :action-table-field-example:`2048` - Defaults to the total RAM of the Linode. * - :action-table-field-name:`root_device` - :action-table-field-type:`str` - :action-table-field-example:`/dev/sda` - The root device to boot. * - :action-table-field-name:`run_level` - :action-table-field-type:`str` - :action-table-field-example:`default` - Defines the state of your Linode after booting. * - :action-table-field-name:`virt_mode` - :action-table-field-type:`str` - :action-table-field-example:`paravirt` - Controls the virtualization mode. .. _commands_linodes_configs-list_attribute_sections_devices: .. rst-class:: action-section-header devices .. 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:`devices.sda.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sda.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdb.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdb.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdc.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdc.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdd.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdd.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sde.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sde.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdf.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdf.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdg.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdg.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. * - :action-table-field-name:`devices.sdh.disk_id` - :action-table-field-type:`int` - :action-table-field-example:`124458` - The Disk ID, or ``null`` if a Volume is assigned to this slot. * - :action-table-field-name:`devices.sdh.volume_id` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The Volume ID, or ``null`` if a Disk is assigned to this slot. .. _commands_linodes_configs-list_attribute_sections_helpers: .. rst-class:: action-section-header helpers .. 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:`helpers.devtmpfs_automount` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Populates the /dev directory early during boot without udev. * - :action-table-field-name:`helpers.distro` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Helps maintain correct inittab/upstart console device. * - :action-table-field-name:`helpers.modules_dep` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Creates a modules dependency file for the Kernel you run. * - :action-table-field-name:`helpers.network` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Automatically configures static networking. * - :action-table-field-name:`helpers.updatedb_disabled` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Disables updatedb cron job to avoid disk thrashing. .. _commands_linodes_configs-list_attribute_sections_interfaces: .. rst-class:: action-section-header interfaces .. 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:`interfaces.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. * - :action-table-field-name:`interfaces.id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The unique ID representing this Interface. * - :action-table-field-name:`interfaces.ip_ranges` - :action-table-field-type:`[]str` - :action-table-field-example:`["10.0.0.64/...c::1:0/112"]` - An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. * - :action-table-field-name:`interfaces.ipam_address` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.1/24` - This Network Interface's private IP address in Classless Inter-Domain Routing (CIDR) notation. * - :action-table-field-name:`interfaces.ipv4.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`203.0.113.2` - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * - :action-table-field-name:`interfaces.ipv4.vpc` - :action-table-field-type:`str` - :action-table-field-example:`10.0.0.2` - The VPC Subnet IPv4 address for this Interface. * - :action-table-field-name:`interfaces.label` - :action-table-field-type:`str` - :action-table-field-example:`example-interface` - The name of this Interface. * - :action-table-field-name:`interfaces.primary` - :action-table-field-type:`bool` - :action-table-field-example:`true` - The primary Interface is configured as the default route to the Linode. * - :action-table-field-name:`interfaces.purpose` - :action-table-field-type:`str` - :action-table-field-example:`vlan` - The type of Interface. * - :action-table-field-name:`interfaces.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`interfaces.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this 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_linodes_disk-view: `disk-view `_ ------------------------------------------------------------------------------- View Disk information for a Disk associated with this Linode. .. 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 linodes disk-view [-h] [--label label] [--size size] [--order-by {label,size}] [--order {asc,desc}] linodeId diskId .. 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 linodes disk-view 123 25674 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. * - :action-table-field-name:`diskId` - :action-table-field-type:`int` - ID of the Disk to look up. .. 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:`2018-01-01T00:01:01` - When this Disk was created. * - :action-table-field-name:`filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`25674` - This Disk's ID which must be provided for all operations impacting this Disk. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Debian 9 Disk` - The Disk's label is for display purposes only. * - :action-table-field-name:`size` - :action-table-field-type:`int` - :action-table-field-example:`48640` - The size of the Disk in MB. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`ready` - A brief description of this Disk's current state. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Disk was last updated. ------------ .. 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_linodes_disk-create: `disk-create `_ -------------------------------------------------------------------------------------- Adds a new Disk to a Linode. .. 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 linodes disk-create [-h] [--authorized_keys authorized_keys] [--size size] [--stackscript_id stackscript_id] [--image image] [--root_pass [ROOT_PASS] ] [--stackscript_data stackscript_data] [--authorized_users authorized_users] [--filesystem filesystem] [--label label] linodeId .. 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 linodes disk-create 123 \ --size 1300 \ --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \ --authorized_users "myUser" \ --authorized_users "secondaryUser" \ --root_pass aComplex@Password \ --image "linode/debian9" \ --stackscript_id 10079 \ --stackscript_data '{"gh_username": "linode"}' .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`\-\-size` :action-table-field-required:`*` - :action-table-field-type:`int` - :action-table-field-example:`48640` - The size of the Disk in MB. * - :action-table-field-name:`\-\-authorized_keys` - :action-table-field-type:`[]str` - :action-table-field-example:`ssh-rsa AAAA_...eir-computer` - :action-argument-additional-details:`(write-only)` A list of public SSH keys that will be automatically appended to the root user's ``~/.ssh/authorized_keys`` file when deploying from an Image. * - :action-table-field-name:`\-\-authorized_users` - :action-table-field-type:`[]str` - :action-table-field-example:`myUser` - :action-argument-additional-details:`(write-only)` A list of usernames. * - :action-table-field-name:`\-\-filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`\-\-image` - :action-table-field-type:`str` - :action-table-field-example:`linode/debian9` - An Image ID to deploy the Linode Disk from. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`Debian 9 Disk` - The Disk's label is for display purposes only. * - :action-table-field-name:`\-\-root_pass` - :action-table-field-type:`str` - :action-table-field-example:`aComplexP@ssword` - :action-argument-additional-details:`(write-only)` This sets the root user's password on a newly-created Linode Disk when deploying from an Image. * - :action-table-field-name:`\-\-stackscript_data` - :action-table-field-type:`json` - :action-table-field-example:`{"gh_username": "linode"}` - This field is required only if the StackScript being deployed requires input data from the User for successful completion. * - :action-table-field-name:`\-\-stackscript_id` - :action-table-field-type:`int` - :action-table-field-example:`10079` - A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. .. 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:`2018-01-01T00:01:01` - When this Disk was created. * - :action-table-field-name:`filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`25674` - This Disk's ID which must be provided for all operations impacting this Disk. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Debian 9 Disk` - The Disk's label is for display purposes only. * - :action-table-field-name:`size` - :action-table-field-type:`int` - :action-table-field-example:`48640` - The size of the Disk in MB. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`ready` - A brief description of this Disk's current state. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Disk was last updated. ------------ .. 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_linodes_disk-update: `disk-update `_ -------------------------------------------------------------------------- Updates a Disk that you have permission to ``read_write``. .. 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 linodes disk-update [-h] [--label label] linodeId diskId .. 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 linodes disk-update 123 25674 \ --label "Debian 9 Disk" .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. * - :action-table-field-name:`diskId` - :action-table-field-type:`int` - ID of the Disk to look up. .. 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:`Debian 9 Disk` - The Disk's label is 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:`2018-01-01T00:01:01` - When this Disk was created. * - :action-table-field-name:`filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`25674` - This Disk's ID which must be provided for all operations impacting this Disk. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Debian 9 Disk` - The Disk's label is for display purposes only. * - :action-table-field-name:`size` - :action-table-field-type:`int` - :action-table-field-example:`48640` - The size of the Disk in MB. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`ready` - A brief description of this Disk's current state. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Disk was last updated. ------------ .. 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_linodes_disk-delete: `disk-delete `_ ----------------------------------------------------------------------------- Deletes a Disk you have permission to ``read_write``. .. 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 linodes disk-delete [-h] linodeId diskId .. 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 linodes disk-delete 123 24674 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. * - :action-table-field-name:`diskId` - :action-table-field-type:`int` - ID of the Disk to look up. ------------ .. 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_linodes_disk-clone: `disk-clone `_ --------------------------------------------------------------------------------------- Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode. .. 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 linodes disk-clone [-h] linodeId diskId .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. * - :action-table-field-name:`diskId` - :action-table-field-type:`int` - ID of the Disk to clone. .. 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:`2018-01-01T00:01:01` - When this Disk was created. * - :action-table-field-name:`filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`25674` - This Disk's ID which must be provided for all operations impacting this Disk. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Debian 9 Disk` - The Disk's label is for display purposes only. * - :action-table-field-name:`size` - :action-table-field-type:`int` - :action-table-field-example:`48640` - The size of the Disk in MB. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`ready` - A brief description of this Disk's current state. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Disk was last updated. ------------ .. 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_linodes_disk-reset-password: `disk-reset-password `_ -------------------------------------------------------------------------------------------------- Resets the password of a Disk you have permission to ``read_write``. .. 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 linodes disk-reset-password [-h] [--password password] linodeId diskId .. 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 linodes disk-reset-password \ 123 25674 \ --password aComplex@Password .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. * - :action-table-field-name:`diskId` - :action-table-field-type:`int` - ID of the Disk to look up. .. 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:`\-\-password` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`another@compl...^Password123` - The new root password for the OS installed on this Disk. ------------ .. 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_linodes_disk-resize: `disk-resize `_ ---------------------------------------------------------------------------------- Resizes a Disk you have permission to ``read_write``. .. 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 linodes disk-resize [-h] [--size size] linodeId diskId .. 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 linodes disk-resize 123 25674 \ --size 2048 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. * - :action-table-field-name:`diskId` - :action-table-field-type:`int` - ID of the Disk to look up. .. 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:`\-\-size` :action-table-field-required:`*` - :action-table-field-type:`int` - :action-table-field-example:`2048` - The desired size, in MB, of the disk. ------------ .. 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_linodes_disks-list: `disks-list `_ --------------------------------------------------------------------------------- View Disk information for Disks associated with this Linode. .. 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 linodes disks-list [-h] [--label label] [--size size] [--order-by {label,size}] [--order {asc,desc}] linodeId .. 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 linodes disks-list 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`\-\-label` - :action-table-field-type:`str` - The Disk's label is for display purposes only. * - :action-table-field-name:`\-\-size` - :action-table-field-type:`int` - The size of the Disk in MB. .. 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:`2018-01-01T00:01:01` - When this Disk was created. * - :action-table-field-name:`filesystem` - :action-table-field-type:`str` - :action-table-field-example:`ext4` - The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`25674` - This Disk's ID which must be provided for all operations impacting this Disk. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Debian 9 Disk` - The Disk's label is for display purposes only. * - :action-table-field-name:`size` - :action-table-field-type:`int` - :action-table-field-example:`48640` - The size of the Disk in MB. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`ready` - A brief description of this Disk's current state. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Disk was last updated. ------------ .. 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_linodes_firewalls-list: `firewalls-list `_ ----------------------------------------------------------------------------------------- View Firewall information for Firewalls assigned to this Linode. .. 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 linodes firewalls-list [-h] [--label label] [--updated updated] [--tags [tags] ] [--id id] [--created created] [--order-by {label,updated,tags,id,created}] [--order {asc,desc}] linodeId .. 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 linodes firewalls-list 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to access. .. 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` - When this Firewall was created. * - :action-table-field-name:`\-\-id` - :action-table-field-type:`int` - The Firewall's unique ID. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The Firewall's label, for display purposes only. * - :action-table-field-name:`\-\-tags` - :action-table-field-type:`[]str` - An array of tags applied to this object. * - :action-table-field-name:`\-\-updated` - :action-table-field-type:`str` - When this Firewall was last updated. .. 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:`2018-01-01T00:01:01` - When this Firewall was created. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The Firewall's unique ID. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`firewall123` - The Firewall's label, for display purposes only. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`enabled` - The status of this Firewall. * - :action-table-field-name:`tags` - :action-table-field-type:`[]str` - :action-table-field-example:`["example ta...er example"]` - An array of tags applied to this object. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-02T00:01:01` - When this Firewall was last updated. .. _commands_linodes_firewalls-list_attribute_sections_rules: .. rst-class:: action-section-header rules .. 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:`rules.inbound.action` - :action-table-field-type:`str` - :action-table-field-example:`ACCEPT` - Controls whether traffic is accepted or dropped by this rule. * - :action-table-field-name:`rules.inbound.addresses.ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["192.0.2.0/2...1.100.2/32"]` - A list of IPv4 addresses or networks. * - :action-table-field-name:`rules.inbound.addresses.ipv6` - :action-table-field-type:`[]str` - :action-table-field-example:`["2001:DB8::/128"]` - A list of IPv6 addresses or networks. * - :action-table-field-name:`rules.inbound.description` - :action-table-field-type:`str` - :action-table-field-example:`An example fi...description.` - Used to describe this rule. * - :action-table-field-name:`rules.inbound.label` - :action-table-field-type:`str` - :action-table-field-example:`firewallrule123` - Used to identify this rule. * - :action-table-field-name:`rules.inbound.ports` - :action-table-field-type:`str` - :action-table-field-example:`22-24, 80, 443` - A string representing the port or ports affected by this rule: - The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges. * - :action-table-field-name:`rules.inbound.protocol` - :action-table-field-type:`str` - :action-table-field-example:`TCP` - The type of network traffic affected by this rule. * - :action-table-field-name:`rules.inbound_policy` - :action-table-field-type:`str` - :action-table-field-example:`DROP` - The default behavior for inbound traffic. * - :action-table-field-name:`rules.outbound.action` - :action-table-field-type:`str` - :action-table-field-example:`ACCEPT` - Controls whether traffic is accepted or dropped by this rule. * - :action-table-field-name:`rules.outbound.addresses.ipv4` - :action-table-field-type:`[]str` - :action-table-field-example:`["192.0.2.0/2...1.100.2/32"]` - A list of IPv4 addresses or networks. * - :action-table-field-name:`rules.outbound.addresses.ipv6` - :action-table-field-type:`[]str` - :action-table-field-example:`["2001:DB8::/128"]` - A list of IPv6 addresses or networks. * - :action-table-field-name:`rules.outbound.description` - :action-table-field-type:`str` - :action-table-field-example:`An example fi...description.` - Used to describe this rule. * - :action-table-field-name:`rules.outbound.label` - :action-table-field-type:`str` - :action-table-field-example:`firewallrule123` - Used to identify this rule. * - :action-table-field-name:`rules.outbound.ports` - :action-table-field-type:`str` - :action-table-field-example:`22-24, 80, 443` - A string representing the port or ports affected by this rule: - The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges. * - :action-table-field-name:`rules.outbound.protocol` - :action-table-field-type:`str` - :action-table-field-example:`TCP` - The type of network traffic affected by this rule. * - :action-table-field-name:`rules.outbound_policy` - :action-table-field-type:`str` - :action-table-field-example:`DROP` - The default behavior for outbound traffic. ------------ .. 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_linodes_ip-view: `ip-view `_ --------------------------------------------------------------------------- View information about the specified IP address associated with the specified Linode. .. 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 linodes ip-view [-h] [--order-by {}] [--order {asc,desc}] linodeId address .. 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 linodes ip-view 123 97.107.143.141 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode. * - :action-table-field-name:`address` - :action-table-field-type:`str` - The IP address. .. 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:`address` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.141` - The IP address. * - :action-table-field-name:`gateway` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.1` - The default gateway for this address. * - :action-table-field-name:`linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`prefix` - :action-table-field-type:`int` - :action-table-field-example:`24` - The number of bits set in the subnet mask. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this is a public or private IP address. * - :action-table-field-name:`rdns` - :action-table-field-type:`str` - :action-table-field-example:`test.example.org` - The reverse DNS assigned to this address. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this IP address resides in. * - :action-table-field-name:`subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.255.0` - The mask that separates host bits from network bits for this address. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address this is. .. _commands_linodes_ip-view_attribute_sections_vpc_nat_1_1: .. rst-class:: action-section-header vpc_nat_1_1 .. 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:`vpc_nat_1_1.address` - :action-table-field-type:`str` - :action-table-field-example:`192.168.0.42` - The IPv4 address that is configured as a 1:1 NAT for this VPC interface. * - :action-table-field-name:`vpc_nat_1_1.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`vpc_nat_1_1.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this 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_linodes_ip-add: `ip-add `_ ------------------------------------------------------------------------------- Allocates a public or private IPv4 address to a Linode. .. 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 linodes ip-add [-h] [--type type] [--public public] linodeId .. 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 linodes ip-add 123 \ --type ipv4 \ --public true .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`\-\-public` :action-table-field-required:`*` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether to create a public or private IPv4 address. * - :action-table-field-name:`\-\-type` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address you are allocating. .. 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:`address` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.141` - The IP address. * - :action-table-field-name:`gateway` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.1` - The default gateway for this address. * - :action-table-field-name:`linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`prefix` - :action-table-field-type:`int` - :action-table-field-example:`24` - The number of bits set in the subnet mask. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this is a public or private IP address. * - :action-table-field-name:`rdns` - :action-table-field-type:`str` - :action-table-field-example:`test.example.org` - The reverse DNS assigned to this address. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this IP address resides in. * - :action-table-field-name:`subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.255.0` - The mask that separates host bits from network bits for this address. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address this is. .. _commands_linodes_ip-add_attribute_sections_vpc_nat_1_1: .. rst-class:: action-section-header vpc_nat_1_1 .. 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:`vpc_nat_1_1.address` - :action-table-field-type:`str` - :action-table-field-example:`192.168.0.42` - The IPv4 address that is configured as a 1:1 NAT for this VPC interface. * - :action-table-field-name:`vpc_nat_1_1.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`vpc_nat_1_1.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this 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_linodes_ip-update: `ip-update `_ ----------------------------------------------------------------------------- Updates the reverse DNS (RDNS) for a Linode's IP Address. .. 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 linodes ip-update [-h] [--rdns rdns] linodeId address .. 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 linodes ip-update 123 \ 203.0.113.1 \ --rdns test.example.org .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode. * - :action-table-field-name:`address` - :action-table-field-type:`str` - The IP address. .. 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:`\-\-rdns` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`test.example.org` - :action-argument-additional-details:`(nullable)` The reverse DNS assigned to this address. .. 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:`address` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.141` - The IP address. * - :action-table-field-name:`gateway` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.1` - The default gateway for this address. * - :action-table-field-name:`linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`prefix` - :action-table-field-type:`int` - :action-table-field-example:`24` - The number of bits set in the subnet mask. * - :action-table-field-name:`public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this is a public or private IP address. * - :action-table-field-name:`rdns` - :action-table-field-type:`str` - :action-table-field-example:`test.example.org` - The reverse DNS assigned to this address. * - :action-table-field-name:`region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this IP address resides in. * - :action-table-field-name:`subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.255.0` - The mask that separates host bits from network bits for this address. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address this is. .. _commands_linodes_ip-update_attribute_sections_vpc_nat_1_1: .. rst-class:: action-section-header vpc_nat_1_1 .. 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:`vpc_nat_1_1.address` - :action-table-field-type:`str` - :action-table-field-example:`192.168.0.42` - The IPv4 address that is configured as a 1:1 NAT for this VPC interface. * - :action-table-field-name:`vpc_nat_1_1.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`vpc_nat_1_1.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this 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_linodes_ip-delete: `ip-delete `_ -------------------------------------------------------------------------------- Deletes a public or private IPv4 address associated with this Linode. .. 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 linodes ip-delete [-h] linodeId address .. 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 linodes ip-delete 97.107.143.141 .. 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:`linodeId` - :action-table-field-type:`int` - The ID of the Linode. * - :action-table-field-name:`address` - :action-table-field-type:`str` - The IP address. ------------ .. 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_linodes_ips-list: `ips-list `_ ----------------------------------------------------------------------------- Returns networking information for a single Linode. .. 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 linodes ips-list [-h] [--ipv4.vpc.config_id ipv4.vpc.config_id] [--ipv4.vpc.linode_id ipv4.vpc.linode_id] [--ipv4.vpc.region ipv4.vpc.region] [--ipv4.vpc.active ipv4.vpc.active] [--ipv4.vpc.vpc_id ipv4.vpc.vpc_id] [--ipv6.link_local.region ipv6.link_local.region] [--ipv6.slaac.region ipv6.slaac.region] [--order-by {ipv4.vpc.config_id,ipv4.vpc.linode_id,ipv4.vpc.region,ipv4.vpc.active,ipv4.vpc.vpc_id,ipv6.link_local.region,ipv6.slaac.region}] [--order {asc,desc}] linodeId .. 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 linodes ips-list 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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. .. _commands_linodes_ips-list_attribute_sections_ipv4: .. rst-class:: action-section-header ipv4 .. 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:`ipv4.private.address` - :action-table-field-type:`str` - :action-table-field-example:`192.168.133.234` - The private IPv4 address. * - :action-table-field-name:`ipv4.private.gateway` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The default gateway for this address. * - :action-table-field-name:`ipv4.private.linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`ipv4.private.prefix` - :action-table-field-type:`int` - :action-table-field-example:`17` - The number of bits set in the subnet mask. * - :action-table-field-name:`ipv4.private.public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Whether this is a public or private IP address. * - :action-table-field-name:`ipv4.private.rdns` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The reverse DNS assigned to this address. * - :action-table-field-name:`ipv4.private.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this address resides in. * - :action-table-field-name:`ipv4.private.subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.128.0` - The mask that separates host bits from network bits for this address. * - :action-table-field-name:`ipv4.private.type` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address this is. * - :action-table-field-name:`ipv4.public.address` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.141` - The IP address. * - :action-table-field-name:`ipv4.public.gateway` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.1` - The default gateway for this address. * - :action-table-field-name:`ipv4.public.linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`ipv4.public.prefix` - :action-table-field-type:`int` - :action-table-field-example:`24` - The number of bits set in the subnet mask. * - :action-table-field-name:`ipv4.public.public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this is a public or private IP address. * - :action-table-field-name:`ipv4.public.rdns` - :action-table-field-type:`str` - :action-table-field-example:`test.example.org` - The reverse DNS assigned to this address. * - :action-table-field-name:`ipv4.public.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this IP address resides in. * - :action-table-field-name:`ipv4.public.subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.255.0` - The mask that separates host bits from network bits for this address. * - :action-table-field-name:`ipv4.public.type` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address this is. * - :action-table-field-name:`ipv4.public.vpc_nat_1_1.address` - :action-table-field-type:`str` - :action-table-field-example:`192.168.0.42` - The IPv4 address that is configured as a 1:1 NAT for this VPC interface. * - :action-table-field-name:`ipv4.public.vpc_nat_1_1.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`ipv4.public.vpc_nat_1_1.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this Interface. * - :action-table-field-name:`ipv4.reserved.address` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.141` - The IP address. * - :action-table-field-name:`ipv4.reserved.gateway` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.1` - The default gateway for this address. * - :action-table-field-name:`ipv4.reserved.linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`ipv4.reserved.prefix` - :action-table-field-type:`int` - :action-table-field-example:`24` - The number of bits set in the subnet mask. * - :action-table-field-name:`ipv4.reserved.public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this is a public or private IP address. * - :action-table-field-name:`ipv4.reserved.rdns` - :action-table-field-type:`str` - :action-table-field-example:`test.example.org` - The reverse DNS assigned to this address. * - :action-table-field-name:`ipv4.reserved.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this IP address resides in. * - :action-table-field-name:`ipv4.reserved.subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.255.0` - The mask that separates host bits from network bits for this address. * - :action-table-field-name:`ipv4.reserved.type` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address this is. * - :action-table-field-name:`ipv4.reserved.vpc_nat_1_1.address` - :action-table-field-type:`str` - :action-table-field-example:`192.168.0.42` - The IPv4 address that is configured as a 1:1 NAT for this VPC interface. * - :action-table-field-name:`ipv4.reserved.vpc_nat_1_1.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`ipv4.reserved.vpc_nat_1_1.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this Interface. * - :action-table-field-name:`ipv4.shared.address` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.141` - The IP address. * - :action-table-field-name:`ipv4.shared.gateway` - :action-table-field-type:`str` - :action-table-field-example:`97.107.143.1` - The default gateway for this address. * - :action-table-field-name:`ipv4.shared.linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`ipv4.shared.prefix` - :action-table-field-type:`int` - :action-table-field-example:`24` - The number of bits set in the subnet mask. * - :action-table-field-name:`ipv4.shared.public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this is a public or private IP address. * - :action-table-field-name:`ipv4.shared.rdns` - :action-table-field-type:`str` - :action-table-field-example:`test.example.org` - The reverse DNS assigned to this address. * - :action-table-field-name:`ipv4.shared.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this IP address resides in. * - :action-table-field-name:`ipv4.shared.subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.255.0` - The mask that separates host bits from network bits for this address. * - :action-table-field-name:`ipv4.shared.type` - :action-table-field-type:`str` - :action-table-field-example:`ipv4` - The type of address this is. * - :action-table-field-name:`ipv4.shared.vpc_nat_1_1.address` - :action-table-field-type:`str` - :action-table-field-example:`192.168.0.42` - The IPv4 address that is configured as a 1:1 NAT for this VPC interface. * - :action-table-field-name:`ipv4.shared.vpc_nat_1_1.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this Interface. * - :action-table-field-name:`ipv4.shared.vpc_nat_1_1.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`111` - The ``id`` of the VPC configured for this Interface. * - :action-table-field-name:`ipv4.vpc.active` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if the VPC interface is in use, meaning that the Linode was powered on using the ``config_id`` to which the interface belongs. * - :action-table-field-name:`ipv4.vpc.address` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.141` - An IPv4 address configured for this VPC interface. * - :action-table-field-name:`ipv4.vpc.address_range` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A range of IPv4 addresses configured for this VPC interface. * - :action-table-field-name:`ipv4.vpc.config_id` - :action-table-field-type:`int` - :action-table-field-example:`4567` - The globally general entity identifier for the Linode configuration profile where the VPC is included. * - :action-table-field-name:`ipv4.vpc.gateway` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.1` - The default gateway for the VPC subnet that the IP or IP range belongs to. * - :action-table-field-name:`ipv4.vpc.interface_id` - :action-table-field-type:`int` - :action-table-field-example:`2435` - The globally general API entity identifier for the Linode interface. * - :action-table-field-name:`ipv4.vpc.linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The identifier for the Linode the VPC interface currently belongs to. * - :action-table-field-name:`ipv4.vpc.nat_1_1` - :action-table-field-type:`str` - :action-table-field-example:`192.168.0.42` - The public IP address used for NAT 1:1 with the VPC. * - :action-table-field-name:`ipv4.vpc.page` - :action-table-field-type:`int` - :action-table-field-example:`1` - The current `page `_. * - :action-table-field-name:`ipv4.vpc.pages` - :action-table-field-type:`int` - :action-table-field-example:`1` - The total number of `pages `_. * - :action-table-field-name:`ipv4.vpc.prefix` - :action-table-field-type:`int` - :action-table-field-example:`24` - The number of bits set in the ``subnet_mask``. * - :action-table-field-name:`ipv4.vpc.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The region of the VPC. * - :action-table-field-name:`ipv4.vpc.results` - :action-table-field-type:`int` - :action-table-field-example:`1` - The total number of results. * - :action-table-field-name:`ipv4.vpc.subnet_id` - :action-table-field-type:`int` - :action-table-field-example:`101` - The ``id`` of the VPC Subnet for this interface. * - :action-table-field-name:`ipv4.vpc.subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`255.255.255.0` - The mask that separates host bits from network bits for the ``address`` or ``address_range``. * - :action-table-field-name:`ipv4.vpc.vpc_id` - :action-table-field-type:`int` - :action-table-field-example:`7654` - The unique globally general API entity identifier for the VPC. .. _commands_linodes_ips-list_attribute_sections_ipv6: .. rst-class:: action-section-header ipv6 .. 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:`ipv6.global.prefix` - :action-table-field-type:`int` - :action-table-field-example:`64` - The prefix length of the address. * - :action-table-field-name:`ipv6.global.range` - :action-table-field-type:`str` - :action-table-field-example:`2600:3c01::` - The IPv6 address of this range. * - :action-table-field-name:`ipv6.global.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The region for this range of IPv6 addresses. * - :action-table-field-name:`ipv6.global.route_target` - :action-table-field-type:`str` - :action-table-field-example:`2600:3c01::f...ff:ffff:ffff` - The IPv6 SLAAC address. * - :action-table-field-name:`ipv6.link_local.address` - :action-table-field-type:`str` - :action-table-field-example:`fe80::f03c:91ff:fe24:3a2f` - The IPv6 link-local address. * - :action-table-field-name:`ipv6.link_local.gateway` - :action-table-field-type:`str` - :action-table-field-example:`fe80::1` - The default gateway for this address. * - :action-table-field-name:`ipv6.link_local.linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`ipv6.link_local.prefix` - :action-table-field-type:`int` - :action-table-field-example:`64` - The network prefix. * - :action-table-field-name:`ipv6.link_local.public` - :action-table-field-type:`bool` - :action-table-field-example:`N/A` - Whether this is a public or private IP address. * - :action-table-field-name:`ipv6.link_local.rdns` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The reverse DNS assigned to this address. * - :action-table-field-name:`ipv6.link_local.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this address resides in. * - :action-table-field-name:`ipv6.link_local.subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`ffff:ffff:ffff:ffff::` - The subnet mask. * - :action-table-field-name:`ipv6.link_local.type` - :action-table-field-type:`str` - :action-table-field-example:`ipv6` - The type of address this is. * - :action-table-field-name:`ipv6.slaac.address` - :action-table-field-type:`str` - :action-table-field-example:`2600:3c03::f...ff:fe24:3a2f` - The address. * - :action-table-field-name:`ipv6.slaac.gateway` - :action-table-field-type:`str` - :action-table-field-example:`fe80::1` - The default gateway for this address. * - :action-table-field-name:`ipv6.slaac.linode_id` - :action-table-field-type:`int` - :action-table-field-example:`123` - The ID of the Linode this address currently belongs to. * - :action-table-field-name:`ipv6.slaac.prefix` - :action-table-field-type:`int` - :action-table-field-example:`64` - The network prefix. * - :action-table-field-name:`ipv6.slaac.public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Whether this is a public or private IP address. * - :action-table-field-name:`ipv6.slaac.rdns` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The reverse DNS assigned to this address. * - :action-table-field-name:`ipv6.slaac.region` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region this address resides in. * - :action-table-field-name:`ipv6.slaac.subnet_mask` - :action-table-field-type:`str` - :action-table-field-example:`ffff:ffff:ffff:ffff::` - The subnet mask. * - :action-table-field-name:`ipv6.slaac.type` - :action-table-field-type:`str` - :action-table-field-example:`ipv6` - The type of address this is. ------------ .. 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_linodes_linode-reset-password: `linode-reset-password `_ ------------------------------------------------------------------------------------------------------ Resets the root password for this Linode. .. 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 linodes linode-reset-password [-h] [--root_pass root_pass] linodeId .. 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 linodes linode-reset-password 123 a$eCure4assw0rd!43v51 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode for which to reset its root password. .. 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:`\-\-root_pass` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`a$eCure4assw0rd!43v51` - The root user's password on this Linode. ------------ .. 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_linodes_transfer-view: `transfer-view `_ --------------------------------------------------------------------------------------- Returns a Linode's network transfer pool statistics for the current month. .. 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 linodes transfer-view [-h] [--order-by {}] [--order {asc,desc}] linodeId .. 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 linodes transfer-view 123 .. 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:`linodeId` - :action-table-field-type:`int` - ID of the Linode to look up. .. 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:`billable` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The amount of network transfer this Linode has used, in GB, past your monthly quota. * - :action-table-field-name:`quota` - :action-table-field-type:`int` - :action-table-field-example:`2000` - The amount of network transfer this Linode adds to your transfer pool, in GB, for the current month's billing cycle. * - :action-table-field-name:`used` - :action-table-field-type:`int` - :action-table-field-example:`22956600198` - The amount of network transfer used by this Linode, in bytes, for the current month's billing cycle. .. 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_linodes_type-view: `type-view `_ ------------------------------------------------------------------------------- Returns information about a specific Linode Type, including pricing and specifications. .. 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 linodes type-view [-h] [--network_out network_out] [--memory memory] [--disk disk] [--class class] [--gpus gpus] [--vcpus vcpus] [--transfer transfer] [--label label] [--order-by {network_out,memory,disk,class,gpus,vcpus,transfer,label}] [--order {asc,desc}] typeId .. 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 linodes type-view g6-standard-2 .. 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:`typeId` - :action-table-field-type:`str` - The ID of the Linode Type to look up. .. 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:`class` - :action-table-field-type:`str` - :action-table-field-example:`standard` - The class of the Linode Type. * - :action-table-field-name:`disk` - :action-table-field-type:`int` - :action-table-field-example:`81920` - The Disk size, in MB, of the Linode Type. * - :action-table-field-name:`gpus` - :action-table-field-type:`int` - :action-table-field-example:`N/A` - The number of GPUs this Linode Type offers. * - :action-table-field-name:`id` - :action-table-field-type:`str` - :action-table-field-example:`g6-standard-2` - The ID representing the Linode Type. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`Linode 4GB` - The Linode Type's label is for display purposes only. * - :action-table-field-name:`memory` - :action-table-field-type:`int` - :action-table-field-example:`4096` - Amount of RAM included in this Linode Type. * - :action-table-field-name:`network_out` - :action-table-field-type:`int` - :action-table-field-example:`1000` - The Mbits outbound bandwidth allocation. * - :action-table-field-name:`successor` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The Linode Type that a `mutate `_ will upgrade to for a Linode of this type. * - :action-table-field-name:`transfer` - :action-table-field-type:`int` - :action-table-field-example:`4000` - The monthly outbound transfer amount, in MB. * - :action-table-field-name:`vcpus` - :action-table-field-type:`int` - :action-table-field-example:`2` - The number of VCPU cores this Linode Type offers. .. _commands_linodes_type-view_attribute_sections_addons: .. rst-class:: action-section-header addons .. 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:`addons.backups.price.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.008` - The cost (in US dollars) per hour to add Backups service. * - :action-table-field-name:`addons.backups.price.monthly` - :action-table-field-type:`float` - :action-table-field-example:`5` - The cost (in US dollars) per month to add Backups service. * - :action-table-field-name:`addons.backups.region_prices.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.0096` - Cost (in US dollars) per hour to add Backups service in this Region. * - :action-table-field-name:`addons.backups.region_prices.id` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region ID for these prices. * - :action-table-field-name:`addons.backups.region_prices.monthly` - :action-table-field-type:`float` - :action-table-field-example:`6` - Cost (in US dollars) per month to add Backups service in this Region. .. _commands_linodes_type-view_attribute_sections_price: .. rst-class:: action-section-header price .. 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:`price.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.03` - Cost (in US dollars) per hour. * - :action-table-field-name:`price.monthly` - :action-table-field-type:`float` - :action-table-field-example:`20` - Cost (in US dollars) per month. .. _commands_linodes_type-view_attribute_sections_region_prices: .. rst-class:: action-section-header region_prices .. 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:`region_prices.hourly` - :action-table-field-type:`float` - :action-table-field-example:`0.036` - Cost (in US dollars) per hour for this Region. * - :action-table-field-name:`region_prices.id` - :action-table-field-type:`str` - :action-table-field-example:`us-east` - The Region ID for these prices. * - :action-table-field-name:`region_prices.monthly` - :action-table-field-type:`float` - :action-table-field-example:`24` - Cost (in US dollars) per month for this Region.