Skip to main content

template parameter show

Contributors
Suggest changes
PDFs

Display template parameters

Availability: This command is available to cluster administrators at the admin privilege level.

Description

The template parameter show command displays information about the parameters of a template. The command output depends on the parameter or parameters specified with the command. If no parameters are specified, the command displays the following information about all the parameters of all the templates in the system:

  • Name of the template

  • Name of the parameter

  • Permission (readonly or readwrite )

  • Default Value for the parameter

  • Readonly

  • Description

To display detailed information about a single parameter of the template run the command with the -name parameter. The detailed view provides all of the information in the previous list with the following additional information:

  • Recommended Value for the parameter

  • Maximum Length

  • Range Maximum

  • Range Minimum

  • Allowed Values

To display detailed information about all the parameters of the template, run the command with the -instance parameter

You can specify additional parameters to display information that matches only those parameters. For example, to display information about all the parameters of the templates with readonly permissions, run the command with the -permission readonly parameter.

Parameters

{ [-fields <fieldname>,…​]

This parameter specifies the fields that need to be displayed.

| [-instance ] }

If this parameter is specified, the command displays information about all entries.

[-template <template name>] - Name of the template

Name of the template.

[-name <text>] - Name of the parameter

If this parameter is specified, the command displays information about the parameter of all the templates that matches the specified parameter name.

[-permission <text>] - Template permission

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified permission.

[-type <text>] - Type of the parameter

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified type.

[-description <text>] - Parameter description

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified description.

[-recommended-value <text>] - Recommended value of the parameter

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified recommended value.

[-default-value <text>] - Default value of the parameter

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified default value.

[-readonly {yes|no}] - Read-only parameter

If this parameter is specified with a value of true, then all the parameters that cannot modified of all templates are displayed. If the value specified is false, then all the parameters that can be modified of all templates are displayed.

[-max-length <integer>] - Maximum length

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified maximum length.

[-range-max <integer>] - Maximum range

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified maximum range.

[-range-min <integer>] - Minumum range

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified minimum range.

[-allowed-vals <text>] - Allowed values

If this parameter is specified, the command displays information about the parameter or parameters of all the templates that matches the specified allowed values.

Examples

The following example displays information about all the parameters of all the templates in the cluster:

cluster1::> template parameter show
  Template: template1
  Permission: readonly
                                 Default      Read
Parameter           Type         Value        Only Description
------------------- ------------ ------------ ---- ----------------------
parameter1          string       -            No   Parameter1
parameter2          IPAddress    -            No   Parameter2