Stackscripts ============ This section details Stackscript-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_stackscripts_list: `list `_ ---------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`ls` If the request is not authenticated, only public StackScripts are returned. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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 stackscripts list [-h] [--label label] [--description description] [--deployments_total deployments_total] [--rev_note rev_note] [--is_public is_public] [--mine mine] [--order-by {label,description,deployments_total,rev_note,is_public,mine}] [--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 stackscripts 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:`\-\-deployments_total` - :action-table-field-type:`int` - The total number of times this StackScript has been deployed. * - :action-table-field-name:`\-\-description` - :action-table-field-type:`str` - A description for the StackScript. * - :action-table-field-name:`\-\-is_public` - :action-table-field-type:`bool` - This determines whether other users can use your StackScript. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - The StackScript's label is for display purposes only. * - :action-table-field-name:`\-\-mine` - :action-table-field-type:`bool` - Returns ``true`` if this StackScript is owned by the account of the user making the request, and the user making the request is unrestricted or has access to this StackScript. * - :action-table-field-name:`\-\-rev_note` - :action-table-field-type:`str` - This field allows you to add notes for the set of revisions made to this StackScript. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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` - The date this StackScript was created. * - :action-table-field-name:`deployments_active` - :action-table-field-type:`int` - :action-table-field-example:`1` - Count of currently active, deployed Linodes created from this StackScript. * - :action-table-field-name:`deployments_total` - :action-table-field-type:`int` - :action-table-field-example:`12` - The total number of times this StackScript has been deployed. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`This StackSc...igures MySQL` - A description for the StackScript. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`10079` - The unique ID of this StackScript. * - :action-table-field-name:`images` - :action-table-field-type:`[]str` - :action-table-field-example:`["linode/deb...de/debian8"]` - An array of Image IDs. * - :action-table-field-name:`is_public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - This determines whether other users can use your StackScript. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`a-stackscript` - The StackScript's label is for display purposes only. * - :action-table-field-name:`mine` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if this StackScript is owned by the account of the user making the request, and the user making the request is unrestricted or has access to this StackScript. * - :action-table-field-name:`rev_note` - :action-table-field-type:`str` - :action-table-field-example:`Set up MySQL` - This field allows you to add notes for the set of revisions made to this StackScript. * - :action-table-field-name:`script` - :action-table-field-type:`str` - :action-table-field-example:`\"#!/bin/bash\"` - The script to execute when provisioning a new Linode with this StackScript. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The date this StackScript was last updated. * - :action-table-field-name:`user_gravatar_id` - :action-table-field-type:`str` - :action-table-field-example:`a445b305abda...bc7fda037c37` - The Gravatar ID for the User who created the StackScript. * - :action-table-field-name:`username` - :action-table-field-type:`str` - :action-table-field-example:`myuser` - The User who created the StackScript. .. _commands_stackscripts_list_attribute_sections_user_defined_fields: .. rst-class:: action-section-header user_defined_fields .. 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:`user_defined_fields.default` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The default value. * - :action-table-field-name:`user_defined_fields.example` - :action-table-field-type:`str` - :action-table-field-example:`hunter2` - An example value for the field. * - :action-table-field-name:`user_defined_fields.label` - :action-table-field-type:`str` - :action-table-field-example:`Enter the password` - A human-readable label for the field that will serve as the input prompt for entering the value during deployment. * - :action-table-field-name:`user_defined_fields.manyOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable values for the field in any quantity, combination or order. * - :action-table-field-name:`user_defined_fields.name` - :action-table-field-type:`str` - :action-table-field-example:`DB_PASSWORD` - The name of the field. * - :action-table-field-name:`user_defined_fields.oneOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable single values for the field. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_stackscripts_view: `view `_ --------------------------------------------------------------------------- Returns all of the information about a specified StackScript, including the contents of the script. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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 stackscripts view [-h] [--deployments_total deployments_total] [--label label] [--description description] [--mine mine] [--is_public is_public] [--rev_note rev_note] [--order-by {deployments_total,label,description,mine,is_public,rev_note}] [--order {asc,desc}] stackscriptId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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 stackscripts view 10079 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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:`stackscriptId` - :action-table-field-type:`str` - The ID of the StackScript 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` - The date this StackScript was created. * - :action-table-field-name:`deployments_active` - :action-table-field-type:`int` - :action-table-field-example:`1` - Count of currently active, deployed Linodes created from this StackScript. * - :action-table-field-name:`deployments_total` - :action-table-field-type:`int` - :action-table-field-example:`12` - The total number of times this StackScript has been deployed. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`This StackSc...igures MySQL` - A description for the StackScript. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`10079` - The unique ID of this StackScript. * - :action-table-field-name:`images` - :action-table-field-type:`[]str` - :action-table-field-example:`["linode/deb...de/debian8"]` - An array of Image IDs. * - :action-table-field-name:`is_public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - This determines whether other users can use your StackScript. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`a-stackscript` - The StackScript's label is for display purposes only. * - :action-table-field-name:`mine` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if this StackScript is owned by the account of the user making the request, and the user making the request is unrestricted or has access to this StackScript. * - :action-table-field-name:`rev_note` - :action-table-field-type:`str` - :action-table-field-example:`Set up MySQL` - This field allows you to add notes for the set of revisions made to this StackScript. * - :action-table-field-name:`script` - :action-table-field-type:`str` - :action-table-field-example:`\"#!/bin/bash\"` - The script to execute when provisioning a new Linode with this StackScript. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The date this StackScript was last updated. * - :action-table-field-name:`user_gravatar_id` - :action-table-field-type:`str` - :action-table-field-example:`a445b305abda...bc7fda037c37` - The Gravatar ID for the User who created the StackScript. * - :action-table-field-name:`username` - :action-table-field-type:`str` - :action-table-field-example:`myuser` - The User who created the StackScript. .. _commands_stackscripts_view_attribute_sections_user_defined_fields: .. rst-class:: action-section-header user_defined_fields .. 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:`user_defined_fields.default` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The default value. * - :action-table-field-name:`user_defined_fields.example` - :action-table-field-type:`str` - :action-table-field-example:`hunter2` - An example value for the field. * - :action-table-field-name:`user_defined_fields.label` - :action-table-field-type:`str` - :action-table-field-example:`Enter the password` - A human-readable label for the field that will serve as the input prompt for entering the value during deployment. * - :action-table-field-name:`user_defined_fields.manyOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable values for the field in any quantity, combination or order. * - :action-table-field-name:`user_defined_fields.name` - :action-table-field-type:`str` - :action-table-field-example:`DB_PASSWORD` - The name of the field. * - :action-table-field-name:`user_defined_fields.oneOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable single values for the field. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_stackscripts_create: `create `_ ---------------------------------------------------------------------------------- Creates a StackScript in 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 stackscripts create [-h] [--description description] [--label label] [--script script] [--images images] [--rev_note rev_note] [--user_defined_fields user_defined_fields] [--is_public is_public] .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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 stackscripts create \ --label a-stackscript \ --description "This StackScript install and configures MySQL" \ --images "linode/debian9" \ --images "linode/debian8" \ --is_public true \ --rev_note "Set up MySQL" \ --script '#!/bin/bash' .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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:`\-\-images` :action-table-field-required:`*` - :action-table-field-type:`[]str` - :action-table-field-example:`linode/debian9` - An array of Image IDs. * - :action-table-field-name:`\-\-label` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`a-stackscript` - The StackScript's label is for display purposes only. * - :action-table-field-name:`\-\-script` :action-table-field-required:`*` - :action-table-field-type:`str` - :action-table-field-example:`\"#!/bin/bash\"` - The script to execute when provisioning a new Linode with this StackScript. * - :action-table-field-name:`\-\-description` - :action-table-field-type:`str` - :action-table-field-example:`This StackSc...igures MySQL` - A description for the StackScript. * - :action-table-field-name:`\-\-is_public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - This determines whether other users can use your StackScript. * - :action-table-field-name:`\-\-rev_note` - :action-table-field-type:`str` - :action-table-field-example:`Set up MySQL` - This field allows you to add notes for the set of revisions made to this StackScript. * - :action-table-field-name:`\-\-user_defined_fields` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - A custom field defined by the User with a special syntax within a StackScript. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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` - The date this StackScript was created. * - :action-table-field-name:`deployments_active` - :action-table-field-type:`int` - :action-table-field-example:`1` - Count of currently active, deployed Linodes created from this StackScript. * - :action-table-field-name:`deployments_total` - :action-table-field-type:`int` - :action-table-field-example:`12` - The total number of times this StackScript has been deployed. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`This StackSc...igures MySQL` - A description for the StackScript. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`10079` - The unique ID of this StackScript. * - :action-table-field-name:`images` - :action-table-field-type:`[]str` - :action-table-field-example:`["linode/deb...de/debian8"]` - An array of Image IDs. * - :action-table-field-name:`is_public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - This determines whether other users can use your StackScript. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`a-stackscript` - The StackScript's label is for display purposes only. * - :action-table-field-name:`mine` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if this StackScript is owned by the account of the user making the request, and the user making the request is unrestricted or has access to this StackScript. * - :action-table-field-name:`rev_note` - :action-table-field-type:`str` - :action-table-field-example:`Set up MySQL` - This field allows you to add notes for the set of revisions made to this StackScript. * - :action-table-field-name:`script` - :action-table-field-type:`str` - :action-table-field-example:`\"#!/bin/bash\"` - The script to execute when provisioning a new Linode with this StackScript. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The date this StackScript was last updated. * - :action-table-field-name:`user_gravatar_id` - :action-table-field-type:`str` - :action-table-field-example:`a445b305abda...bc7fda037c37` - The Gravatar ID for the User who created the StackScript. * - :action-table-field-name:`username` - :action-table-field-type:`str` - :action-table-field-example:`myuser` - The User who created the StackScript. .. _commands_stackscripts_create_attribute_sections_user_defined_fields: .. rst-class:: action-section-header user_defined_fields .. 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:`user_defined_fields.default` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The default value. * - :action-table-field-name:`user_defined_fields.example` - :action-table-field-type:`str` - :action-table-field-example:`hunter2` - An example value for the field. * - :action-table-field-name:`user_defined_fields.label` - :action-table-field-type:`str` - :action-table-field-example:`Enter the password` - A human-readable label for the field that will serve as the input prompt for entering the value during deployment. * - :action-table-field-name:`user_defined_fields.manyOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable values for the field in any quantity, combination or order. * - :action-table-field-name:`user_defined_fields.name` - :action-table-field-type:`str` - :action-table-field-example:`DB_PASSWORD` - The name of the field. * - :action-table-field-name:`user_defined_fields.oneOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable single values for the field. ------------ .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: 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_stackscripts_update: `update `_ ----------------------------------------------------------------------------- Updates a StackScript. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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 stackscripts update [-h] [--label label] [--description description] [--script script] [--images images] [--user_defined_fields user_defined_fields] [--rev_note rev_note] [--is_public is_public] stackscriptId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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 stackscripts update 10079 \ --label a-stackscript \ --description "This StackScript installs \ and configures MySQL" \ --images "linode/debian9" \ --images "linode/debian8" \ --is_public true \ --rev_note "Set up MySQL" \ --script '#!/bin/bash' .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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:`stackscriptId` - :action-table-field-type:`str` - The ID of the StackScript 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:`\-\-description` - :action-table-field-type:`str` - :action-table-field-example:`This StackSc...igures MySQL` - A description for the StackScript. * - :action-table-field-name:`\-\-images` - :action-table-field-type:`[]str` - :action-table-field-example:`linode/debian9` - An array of Image IDs. * - :action-table-field-name:`\-\-is_public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - This determines whether other users can use your StackScript. * - :action-table-field-name:`\-\-label` - :action-table-field-type:`str` - :action-table-field-example:`a-stackscript` - The StackScript's label is for display purposes only. * - :action-table-field-name:`\-\-rev_note` - :action-table-field-type:`str` - :action-table-field-example:`Set up MySQL` - This field allows you to add notes for the set of revisions made to this StackScript. * - :action-table-field-name:`\-\-script` - :action-table-field-type:`str` - :action-table-field-example:`\"#!/bin/bash\"` - The script to execute when provisioning a new Linode with this StackScript. * - :action-table-field-name:`\-\-user_defined_fields` - :action-table-field-type:`json` - :action-table-field-example:`N/A` - A custom field defined by the User with a special syntax within a StackScript. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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` - The date this StackScript was created. * - :action-table-field-name:`deployments_active` - :action-table-field-type:`int` - :action-table-field-example:`1` - Count of currently active, deployed Linodes created from this StackScript. * - :action-table-field-name:`deployments_total` - :action-table-field-type:`int` - :action-table-field-example:`12` - The total number of times this StackScript has been deployed. * - :action-table-field-name:`description` - :action-table-field-type:`str` - :action-table-field-example:`This StackSc...igures MySQL` - A description for the StackScript. * - :action-table-field-name:`id` - :action-table-field-type:`int` - :action-table-field-example:`10079` - The unique ID of this StackScript. * - :action-table-field-name:`images` - :action-table-field-type:`[]str` - :action-table-field-example:`["linode/deb...de/debian8"]` - An array of Image IDs. * - :action-table-field-name:`is_public` - :action-table-field-type:`bool` - :action-table-field-example:`true` - This determines whether other users can use your StackScript. * - :action-table-field-name:`label` - :action-table-field-type:`str` - :action-table-field-example:`a-stackscript` - The StackScript's label is for display purposes only. * - :action-table-field-name:`mine` - :action-table-field-type:`bool` - :action-table-field-example:`true` - Returns ``true`` if this StackScript is owned by the account of the user making the request, and the user making the request is unrestricted or has access to this StackScript. * - :action-table-field-name:`rev_note` - :action-table-field-type:`str` - :action-table-field-example:`Set up MySQL` - This field allows you to add notes for the set of revisions made to this StackScript. * - :action-table-field-name:`script` - :action-table-field-type:`str` - :action-table-field-example:`\"#!/bin/bash\"` - The script to execute when provisioning a new Linode with this StackScript. * - :action-table-field-name:`updated` - :action-table-field-type:`str` - :action-table-field-example:`2018-01-01T00:01:01` - The date this StackScript was last updated. * - :action-table-field-name:`user_gravatar_id` - :action-table-field-type:`str` - :action-table-field-example:`a445b305abda...bc7fda037c37` - The Gravatar ID for the User who created the StackScript. * - :action-table-field-name:`username` - :action-table-field-type:`str` - :action-table-field-example:`myuser` - The User who created the StackScript. .. _commands_stackscripts_update_attribute_sections_user_defined_fields: .. rst-class:: action-section-header user_defined_fields .. 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:`user_defined_fields.default` - :action-table-field-type:`str` - :action-table-field-example:`N/A` - The default value. * - :action-table-field-name:`user_defined_fields.example` - :action-table-field-type:`str` - :action-table-field-example:`hunter2` - An example value for the field. * - :action-table-field-name:`user_defined_fields.label` - :action-table-field-type:`str` - :action-table-field-example:`Enter the password` - A human-readable label for the field that will serve as the input prompt for entering the value during deployment. * - :action-table-field-name:`user_defined_fields.manyOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable values for the field in any quantity, combination or order. * - :action-table-field-name:`user_defined_fields.name` - :action-table-field-type:`str` - :action-table-field-example:`DB_PASSWORD` - The name of the field. * - :action-table-field-name:`user_defined_fields.oneOf` - :action-table-field-type:`str` - :action-table-field-example:`avalue,anoth...e,thirdvalue` - A list of acceptable single values for the field. .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-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_stackscripts_delete: `delete `_ -------------------------------------------------------------------------------- .. rst-class:: action-keyword :action-keyword-key:`Aliases:` :action-keyword-values:`rm` Deletes a private StackScript 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 stackscripts delete [-h] stackscriptId .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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 stackscripts delete 10079 .. role:: action-keyword-key .. role:: action-keyword-values .. role:: action-table-field-name .. role:: action-table-field-optional .. role:: action-table-field-required .. 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:`stackscriptId` - :action-table-field-type:`str` - The ID of the StackScript to look up.