StyleBook configuration

Parameter reference

January 8, 2024

Contributed by:

In the components construct, you refer to the parameters defined in the parameters section by using $parameters.<parametername> notation. If <parametername> itself contains parameters (when type is object), then you must use the notation $parameters.<parametername>.<sub-parametername>, and so on.

Example:

parameters:

  -

    name: name

    label: Name

    type: string

    required: true

     -

      name: vip

      label: Virtual IP and Port

      type: object

      required: true

      parameters:

        -

          name: ip

          label: Virtual IP

          description: The Virtual IP Address

          type: ipaddress

          required: true

            -

              name: port

              label: The Virtual Port

              description: The TCP port for the Virtual IP

              type: tcp-port

              default: 80

components:

  -

    name: my-lbvserver-comp

    type: ns::lbvserver

    properties:

       name: $parameters.name

       servicetype: HTTP

       ipv46: $parameters.vip.ip

       port: $parameters.vip.port
<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Parameter reference

January 8, 2024

Contributed by:

January 8, 2024

Contributed by:

Parameter reference

In this article