Domains ======= This section details Domain-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_domains_list: `list `_ ---------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`ls` This is a collection of Domains that you have registered in Linode's DNS Manager. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains list [-h] [--group group] [--domain domain] [--tags [tags] ] [--order-by {group,domain,tags}] [--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 domains 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:`\-\-domain` - :action-table-field-type:`str` - The domain this Domain represents. * - :action-table-field-name:`\-\-group` - :action-table-field-type:`str` - The group this Domain belongs to. * - :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:`axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`domain` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The group this Domain belongs to. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - This Domain's unique ID. * - :action-table-field-name:`master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_view: `view `_ --------------------------------------------------------------------- This is a single Domain that you have registered in Linode's DNS Manager. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains view [-h] [--tags [tags] ] [--group group] [--domain domain] [--order-by {tags,group,domain}] [--order {asc,desc}] domainId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains 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:`domainId` - :action-table-field-type:`int` - The ID of the Domain 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 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:`axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`domain` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The group this Domain belongs to. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - This Domain's unique ID. * - :action-table-field-name:`master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_create: `create `_ ------------------------------------------------------------------------ Adds a new Domain to Linode's DNS Manager. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains create [-h] [--master_ips master_ips] [--ttl_sec ttl_sec] [--retry_sec retry_sec] [--axfr_ips axfr_ips] [--soa_email soa_email] [--description description] [--type type] [--refresh_sec refresh_sec] [--tags tags] [--status status] [--domain domain] [--group group] [--expire_sec expire_sec] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains create \ --type master \ --domain example.org \ --soa_email admin@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 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:`\-\-domain` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`\-\-type` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). * - :action-table-field-name:`\-\-axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`\-\-description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`\-\-expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`\-\-group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(deprecated)` The group this Domain belongs to. * - :action-table-field-name:`\-\-master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`\-\-refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`\-\-retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`\-\-soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`\-\-status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`\-\-ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`domain` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The group this Domain belongs to. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - This Domain's unique ID. * - :action-table-field-name:`master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_update: `update `_ ----------------------------------------------------------------------- Update information about a Domain in Linode's DNS Manager. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains update [-h] [--ttl_sec ttl_sec] [--retry_sec retry_sec] [--master_ips master_ips] [--description description] [--type type] [--soa_email soa_email] [--axfr_ips axfr_ips] [--tags tags] [--refresh_sec refresh_sec] [--expire_sec expire_sec] [--group group] [--domain domain] [--status status] domainId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains update 1234 \ --retry_sec 7200 \ --ttl_sec 300 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`int` - The ID of the Domain 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 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:`\-\-axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`\-\-description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`\-\-domain` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`\-\-expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`\-\-group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(deprecated)` The group this Domain belongs to. * - :action-table-field-name:`\-\-master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`\-\-refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`\-\-retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`\-\-soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`\-\-status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`\-\-ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`\-\-type` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`domain` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The group this Domain belongs to. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - This Domain's unique ID. * - :action-table-field-name:`master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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_domains_delete: `delete `_ -------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`rm` Deletes a Domain from Linode's DNS Manager. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains delete [-h] domainId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains delete 1234 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`int` - The ID of the Domain 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 .. _commands_domains_clone: `clone `_ ----------------------------------------------------------------------------- Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains clone [-h] [--domain domain] domainId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains clone 123 --domain example.com .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`str` - ID of the Domain 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:`\-\-domain` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The new domain for the 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:`axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`domain` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The group this Domain belongs to. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - This Domain's unique ID. * - :action-table-field-name:`master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_import: `import `_ ------------------------------------------------------------------------------- Imports a domain zone from a remote nameserver. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains import [-h] [--domain domain] [--remote_nameserver remote_nameserver] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains import --domain example.com --remote_nameserver examplenameserver.com .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`\-\-domain` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`example.com` - The domain to import. * - :action-table-field-name:`\-\-remote_nameserver` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`examplenameserver.com` - The remote nameserver that allows zone transfers (AXFR). .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`axfr_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The list of IPs that may perform a zone transfer for this Domain. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - A description for this Domain. * - :action-table-field-name:`domain` - :action-table-field-type:`str` - :action-table-field-example:`example.org` - The domain this Domain represents. * - :action-table-field-name:`expire_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds that may pass before this Domain is no longer authoritative. * - :action-table-field-name:`group` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The group this Domain belongs to. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`1234` - This Domain's unique ID. * - :action-table-field-name:`master_ips` - :action-table-field-type:`[]str` - :action-table-field-example:`N/A` - The IP addresses representing the master DNS for this Domain. * - :action-table-field-name:`refresh_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The amount of time in seconds before this Domain should be refreshed. * - :action-table-field-name:`retry_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - The interval, in seconds, at which a failed refresh should be retried. * - :action-table-field-name:`soa_email` - :action-table-field-type:`str` - :action-table-field-example:`admin@example.org` - Start of Authority email address. * - :action-table-field-name:`status` - :action-table-field-type:`str` - :action-table-field-example:`active` - Used to control whether this Domain is currently being rendered. * - :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:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`300` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`master` - Whether this Domain represents the authoritative source of information for the domain it describes (``master``), or whether it is a read-only copy of a master (``slave``). ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_records-list: `records-list `_ ------------------------------------------------------------------------------------- Returns a paginated list of Records configured on a Domain in Linode's DNS Manager. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-list [-h] [--tag tag] [--name name] [--target target] [--type type] [--order-by {tag,name,target,type}] [--order {asc,desc}] domainId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-list 1234 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`int` - The ID of the Domain we are accessing Records 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:`\-\-name` - :action-table-field-type:`str` - The name of this Record. * - :action-table-field-name:`\-\-tag` - :action-table-field-type:`str` - The tag portion of a CAA record. * - :action-table-field-name:`\-\-target` - :action-table-field-type:`str` - The target for this Record. * - :action-table-field-name:`\-\-type` - :action-table-field-type:`str` - The type of Record this is in the DNS system. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 Domain Record was created. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123456` - This Record's unique ID. * - :action-table-field-name:`name` - :action-table-field-type:`str` - :action-table-field-example:`test` - The name of this Record. * - :action-table-field-name:`port` - :action-table-field-type:`int` - :action-table-field-example:`80` - The port this Record points to. * - :action-table-field-name:`priority` - :action-table-field-type:`int` - :action-table-field-example:`50` - The priority of the target host for this Record. * - :action-table-field-name:`protocol` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The protocol this Record's service communicates with. * - :action-table-field-name:`service` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The name of the service. * - :action-table-field-name:`tag` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The tag portion of a CAA record. * - :action-table-field-name:`target` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The target for this Record. * - :action-table-field-name:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`604800` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`A` - The type of Record this is in the DNS system. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Domain Record was last updated. * - :action-table-field-name:`weight` - :action-table-field-type:`int` - :action-table-field-example:`50` - The relative weight of this Record used in the case of identical priority. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_records-view: `records-view `_ ------------------------------------------------------------------------------------ View a single Record on this Domain. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-view [-h] [--target target] [--tag tag] [--name name] [--type type] [--order-by {target,tag,name,type}] [--order {asc,desc}] domainId recordId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-view 123 234 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`int` - The ID of the Domain whose Record you are accessing. * - :action-table-field-name:`recordId` - :action-table-field-type:`int` - The ID of the Record you are accessing. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 Domain Record was created. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123456` - This Record's unique ID. * - :action-table-field-name:`name` - :action-table-field-type:`str` - :action-table-field-example:`test` - The name of this Record. * - :action-table-field-name:`port` - :action-table-field-type:`int` - :action-table-field-example:`80` - The port this Record points to. * - :action-table-field-name:`priority` - :action-table-field-type:`int` - :action-table-field-example:`50` - The priority of the target host for this Record. * - :action-table-field-name:`protocol` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The protocol this Record's service communicates with. * - :action-table-field-name:`service` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The name of the service. * - :action-table-field-name:`tag` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The tag portion of a CAA record. * - :action-table-field-name:`target` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The target for this Record. * - :action-table-field-name:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`604800` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`A` - The type of Record this is in the DNS system. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Domain Record was last updated. * - :action-table-field-name:`weight` - :action-table-field-type:`int` - :action-table-field-example:`50` - The relative weight of this Record used in the case of identical priority. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_records-create: `records-create `_ --------------------------------------------------------------------------------------- Adds a new Domain Record to the zonefile this Domain represents. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-create [-h] [--type type] [--weight weight] [--service service] [--priority priority] [--ttl_sec ttl_sec] [--port port] [--protocol protocol] [--tag tag] [--name name] [--target target] domainId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-create 123 \ --type A \ --name test \ --target 203.0.113.1 \ --priority 50 \ --weight 50 \ --port 80 \ --ttl_sec 604800 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`int` - The ID of the Domain we are accessing Records 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:`\-\-type` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`A` - The type of Record this is in the DNS system. * - :action-table-field-name:`\-\-name` - :action-table-field-type:`str` - :action-table-field-example:`test` - The name of this Record. * - :action-table-field-name:`\-\-port` - :action-table-field-type:`int` - :action-table-field-example:`80` - The port this Record points to. * - :action-table-field-name:`\-\-priority` - :action-table-field-type:`int` - :action-table-field-example:`50` - The priority of the target host for this Record. * - :action-table-field-name:`\-\-protocol` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(nullable)` The protocol this Record's service communicates with. * - :action-table-field-name:`\-\-service` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(nullable)` The name of the service. * - :action-table-field-name:`\-\-tag` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(nullable)` The tag portion of a CAA record. * - :action-table-field-name:`\-\-target` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The target for this Record. * - :action-table-field-name:`\-\-ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`604800` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`\-\-weight` - :action-table-field-type:`int` - :action-table-field-example:`50` - The relative weight of this Record used in the case of identical priority. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 Domain Record was created. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123456` - This Record's unique ID. * - :action-table-field-name:`name` - :action-table-field-type:`str` - :action-table-field-example:`test` - The name of this Record. * - :action-table-field-name:`port` - :action-table-field-type:`int` - :action-table-field-example:`80` - The port this Record points to. * - :action-table-field-name:`priority` - :action-table-field-type:`int` - :action-table-field-example:`50` - The priority of the target host for this Record. * - :action-table-field-name:`protocol` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The protocol this Record's service communicates with. * - :action-table-field-name:`service` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The name of the service. * - :action-table-field-name:`tag` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The tag portion of a CAA record. * - :action-table-field-name:`target` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The target for this Record. * - :action-table-field-name:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`604800` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`A` - The type of Record this is in the DNS system. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Domain Record was last updated. * - :action-table-field-name:`weight` - :action-table-field-type:`int` - :action-table-field-example:`50` - The relative weight of this Record used in the case of identical priority. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_records-update: `records-update `_ -------------------------------------------------------------------------------------- Updates a single Record on this Domain. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-update [-h] [--ttl_sec ttl_sec] [--priority priority] [--service service] [--port port] [--name name] [--weight weight] [--tag tag] [--protocol protocol] [--target target] domainId recordId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-update 123 234 \ --name test \ --target 203.0.113.1 \ --priority 50 \ --weight 50 \ --port 80 \ --ttl_sec 604800 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`int` - The ID of the Domain whose Record you are accessing. * - :action-table-field-name:`recordId` - :action-table-field-type:`int` - The ID of the Record you are accessing. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`\-\-name` - :action-table-field-type:`str` - :action-table-field-example:`test` - The name of this Record. * - :action-table-field-name:`\-\-port` - :action-table-field-type:`int` - :action-table-field-example:`80` - The port this Record points to. * - :action-table-field-name:`\-\-priority` - :action-table-field-type:`int` - :action-table-field-example:`50` - The priority of the target host for this Record. * - :action-table-field-name:`\-\-protocol` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(nullable)` The protocol this Record's service communicates with. * - :action-table-field-name:`\-\-service` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(nullable)` The name of the service. * - :action-table-field-name:`\-\-tag` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - :action-argument-additional-details:`(nullable)` The tag portion of a CAA record. * - :action-table-field-name:`\-\-target` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The target for this Record. * - :action-table-field-name:`\-\-ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`604800` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`\-\-weight` - :action-table-field-type:`int` - :action-table-field-example:`50` - The relative weight of this Record used in the case of identical priority. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 Domain Record was created. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`123456` - This Record's unique ID. * - :action-table-field-name:`name` - :action-table-field-type:`str` - :action-table-field-example:`test` - The name of this Record. * - :action-table-field-name:`port` - :action-table-field-type:`int` - :action-table-field-example:`80` - The port this Record points to. * - :action-table-field-name:`priority` - :action-table-field-type:`int` - :action-table-field-example:`50` - The priority of the target host for this Record. * - :action-table-field-name:`protocol` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The protocol this Record's service communicates with. * - :action-table-field-name:`service` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The name of the service. * - :action-table-field-name:`tag` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The tag portion of a CAA record. * - :action-table-field-name:`target` - :action-table-field-type:`str` - :action-table-field-example:`192.0.2.0` - The target for this Record. * - :action-table-field-name:`ttl_sec` - :action-table-field-type:`int` - :action-table-field-example:`604800` - "Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. * - :action-table-field-name:`type` - :action-table-field-type:`str` - :action-table-field-example:`A` - The type of Record this is in the DNS system. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - When this Domain Record was last updated. * - :action-table-field-name:`weight` - :action-table-field-type:`int` - :action-table-field-example:`50` - The relative weight of this Record used in the case of identical priority. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_records-delete: `records-delete `_ ----------------------------------------------------------------------------------------- Deletes a Record on this Domain. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-delete [-h] domainId recordId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains records-delete 123 234 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`domainId` - :action-table-field-type:`int` - The ID of the Domain whose Record you are accessing. * - :action-table-field-name:`recordId` - :action-table-field-type:`int` - The ID of the Record you are accessing. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_domains_zone-file: `zone-file `_ ------------------------------------------------------------------------------- Returns the zone file for the last rendered zone for the specified domain. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains zone-file [-h] [--order-by {}] [--order {asc,desc}] domainId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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 domains zone-file 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:`domainId` - :action-table-field-type:`str` - ID of the Domain. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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:`zone_file` - :action-table-field-type:`[]str` - :action-table-field-example:`["; example....inode.com."]` - The lines of the zone file for the last rendered zone for this domain.