Product Documentation

매개 변수

Oct 18, 2016

이 섹션에서는 StyleBook에서 구성을 만들 때 필요한 모든 매개 변수를 정의합니다. StyleBook이 사용하는 입력을 설명합니다. 이 섹션은 선택적이지만 대부분의 StyleBook에 이 섹션이 하나 필요합니다. parameters 섹션을 이용하여 사용자가 StyleBook을 사용하여 NetScaler 인스턴스에서 구성을 만들 때 답할 질문을 정의할 수 있습니다.

StyleBook을 NetScaler MAS로 가져온 다음 이를 사용하여 구성을 만들 때 GUI에서는 StyleBook의 이 섹션을 사용하여 정의한 매개 변수의 값을 입력할 수 있는 양식을 표시합니다.

다음 표에는 이 섹션의 각 매개 변수에 대해 지정해야 하는 특성에 대한 설명이 나와 있습니다.

특성 설명 필수
name

정의하려는 매개 변수의 이름입니다. 영숫자 이름을 지정할 수 있습니다. 이름은 알파벳으로 시작해야 하며 추가로 알파벳, 숫자, 하이픈(-) 또는 밑줄(_)을 포함할 수 있습니다.

StyleBook을 작성할 때 $parameters. 표기법으로 이 "name" 특성을 사용하여 다른 섹션의 매개 변수를 참조할 수 있습니다.

label NetScaler MAS GUI에 이 매개 변수의 이름으로 표시되는 문자열입니다. 아니요
description 매개 변수의 용도를 설명하는 도움말 문자열입니다. 사용자가 이 매개 변수에 대한 도움말 아이콘을 클릭하면 NetScaler MAS GUI에 이 텍스트가 표시됩니다. 아니요
type

이러한 매개 변수에 사용할 수 있는 값의 유형입니다. 매개 변수는 다음과 같은 기본 제공 유형 중 하나일 수 있습니다.

  • string: 문자열입니다. 길이를 지정하지 않은 경우 문자열 값은 모든 수의 문자를 사용할 수 있습니다. 그러나 min-length 및 max-length 특성을 사용하여 문자열 유형의 길이를 제한할 수 있습니다.

  • number: 정수입니다. min-value 및 max-value 특성을 사용하여 이 유형이 사용할 수 있는 최소 및 최대 수를 지정할 수 있습니다.

  • boolean: true 또는 false입니다. 또한 모든 리터럴은 YAML에서 부울로 간주됩니다(예: Yes 또는 No).

  • ipaddress: 유효한 IPv4 또는 IPv6 주소를 나타내는 문자열입니다.

  • tcp-port: 0에서 65535 사이의 숫자로 TCP 또는 UDP 포트를 나타냅니다.

  • password: 쉽게 알 수 없는/비밀 문자열 값을 나타냅니다. NetScaler MAS GUI에 이 매개 변수의 값이 표시될 때 별표(*****)로 표시됩니다.

  • certfile: 인증서 파일을 나타냅니다. 이 유형을 사용하면 NetScaler MAS GUI를 통해 StyleBook 구성을 만들 때 로컬 시스템에서 직접 파일을 업로드할 수 있습니다. 업로드된 인증서 키 파일은 NetScaler MAS의 /var/mps/tenants//ns_ssl_certs 디렉터리에 저장됩니다. 인증서 파일은 NetScaler MAS에 의해 관리되는 인증서 목록에 추가됩니다.

  • keyfile: 인증서 키 파일을 나타냅니다. 이 유형을 사용하면 NetScaler MAS GUI를 통해 StyleBook 구성을 만들 때 로컬 시스템에서 직접 파일을 업로드할 수 있습니다. 업로드된 인증서 키 파일은 NetScaler MAS의 /var/mps/tenants//ns_ssl_keys 디렉터리에 저장됩니다. 인증서 키 파일은 NetScaler MAS에 의해 관리되는 인증서 키 목록에 추가됩니다.

  • file: 파일을 나타냅니다.

  • object: 이 유형은 여러 관련 매개 변수를 상위 요소 아래에 그룹화하려는 경우에 사용됩니다. 상위 매개 변수를 "object" 유형으로 지정해야 합니다. "object" 유형의 매개 변수에서는 포함된 매개 변수를 설명하는 "parameters" 섹션을 중첩하여 사용할 수 있습니다.

  • 또 다른 StyleBook: 이 유형의 매개 변수를 사용할 경우 이 매개 변수의 값은 해당 유형을 나타내는 StyleBook에 정의된 매개 변수의 형식이어야 합니다.

매개 변수의 유형이 위에 나열된 유형의 목록일 수도 있습니다. 이러한 유형을 정의하려면 유형 끝에 "[]"를 추가합니다. 예를 들어 type 특성이 string[]인 경우 이 매개 변수는 입력으로 문자열의 목록을 사용합니다. 이 StyleBook에서 구성을 만들 때 이 매개 변수에 대해 하나 이상의 문자열을 입력할 수 있습니다.

key

true 또는 false를 지정하여 이 매개 변수가 StyleBook의 키 매개 변수인지 여부를 나타냅니다. StyleBook에서 매개 변수 하나만 "키" 매개 변수로 정의할 수 있습니다.

동일하거나 서로 다른 NetScaler 인스턴스에서 동일한 StyleBook을 사용하여 서로 다른 구성을 만들 경우 각 구성은 이 매개 변수에 대해 서로 다른 고유한 값을 갖게 됩니다.

기본값은 false입니다.

아니요
required

true 또는 false를 지정하여 매개 변수가 필수인지, 아니면 선택적인지 여부를 나타냅니다. true로 설정된 경우 매개 변수가 필수이며 사용자는 구성을 만들 때 이 매개 변수에 대한 값을 입력해야 합니다. NetScaler MAS GUI는 사용자가 이 매개 변수에 유효한 값을 입력하도록 합니다.

기본값은 false입니다.

아니요
allowed-values

type이 "string"으로 설정된 경우 이 특성을 사용하여 매개 변수의 유효한 값 목록을 정의합니다. NetScaler MAS GUI에서 구성을 만들 때 이 목록에서 매개 변수 값을 선택하라는 메시지가 표시됩니다.

예제 1:

   name: ipaddress

   type: string

   allowed-values:

        - SOURCEIP

        - DESTIP

        - NONE

예제 2:

     name: TCP Port

     type: tcp-port

     allowed-values:    

         - 80

         - 81

         - 8080

 예 3: (tcpports의 목록, 여기서 목록의 각 요소는 allowed-values에 지정된 값만 가질 수 있음)

    name: tcpports

    type: tcp-port[]

    allowed-values:

       -80

       -81

       -8080

       -8081

아니요
default

선택적 매개 변수에 기본값을 할당하려면 이 특성을 사용합니다. 구성을 만들 때 사용자가 값을 지정하지 않으면 기본값이 사용됩니다.

NetScaler MAS GUI에서 구성을 만들 때 사용자가 기본값이 없는 매개 변수의 값을 제공하지 않으면 해당 매개 변수에 값이 설정되지 않습니다.

예제 1:

   name: timeout

   type: number

   default: 20

예제 2(매개 변수의 기본값이 값의 목록인 경우):

   name: protocols

   type: string[]

   default:

          -  TCP

          -  UDP

          -  IP

예제 3:

      name: timeout

      type: number

      default: 20

예제 4:

     name: tcpport

     type: tcp-port

     default: 20 

아니요
pattern

매개 변수 유형이 "string"인 경우 이 매개 변수의 유효한 값에 대한 패턴(정규식)을 정의하려면 이 특성을 사용합니다.

예제:

    name: appname

    type: string

    pattern: "[a-z]+"

아니요
min-value

"number" 또는 "tcp-port" 유형의 매개 변수에 대해 최소값을 정의하려면 이 특성을 사용합니다. 

예제:

   name: audio-port

   type: tcp-port

   min-value: 5000

numbers의 min-value는 음수일 수 있지만, tcp-port의 min-value는 음수가 아니어야 합니다.

아니요
max-value

"number" 또는 "tcp-port" 유형의 매개 변수에 대해 최대값을 정의하려면 이 특성을 사용합니다. 이 최대값은 최소값보다 커야 합니다(정의된 경우).

예제:

   name: audio-port

   type: tcp-port

   min-value: 5000

   max-value: 15000

아니요
min-length

"string" 유형의 매개 변수에 대해 허용되는 값의 최소 길이를 정의하려면 이 특성을 사용합니다. 값으로 정의된 문자의 최소 길이는 0보다 크거나 같아야 합니다.

예제:

   name: appname

   type: string

   min-length: 3

아니요
max-length

"string" 유형의 매개 변수에 대해 허용되는 값의 최대 길이를 정의하려면 이 특성을 사용합니다. 값의 최대 길이는 min-length로 정의된 문자의 길이보다 크거나 같아야 합니다.

예제:

   name: appname

   type: string

   max-length: 64

아니요
min-items

목록 유형의 매개 변수에서 최소 항목 수를 정의하려면 이 특성을 사용합니다. 최소 항목 수는 0보다 크거나 같아야 합니다.

예제:

   name: server-ips

   type: ipaddress[]

   min-items: 2

아니요
max-items

목록 유형의 매개 변수에서 최대 항목 수를 정의하려면 이 특성을 사용합니다. 최대 항목 수는 최소 항목 수보다 커야 합니다(정의된 경우).

예제:

   name: server-ips

   type: ipaddress[]

   min-items: 2

   max-items: 250

아니요
gui NetScaler MAS GUI에서 "object" 유형의 매개 변수 레이아웃을 사용자 지정하려면 이 특성을 사용합니다. 아니요
columns gui 특성의 하위 특성입니다. NetScaler MAS GUI에 표시할 열 수를 정의하려면 이 특성을 사용합니다. 아니요
updatable gui 특성의 하위 특성입니다. 구성을 만든 후에 매개 변수를 업데이트할 수 있는지 여부를 지정하려면 이 특성을 사용합니다. 값을 false로 설정하면 구성을 업데이트할 때 매개 변수 필드가 회색으로 표시됩니다. 아니요
collapse_pane

gui 특성의 하위 특성입니다. 이 개체 매개 변수의 레이아웃을 정의하는 창을 축소할 수 있는지 여부를 지정하려면 이 특성을 사용합니다. 값을 true로 설정하면 사용자가 이 상위 매개 변수 아래에서 하위 매개 변수를 확장하거나 축소할 수 있습니다.

예제:

     gui:

        collapse_pane: true

        columns: 2

        updatable: false

아니요


완전한 parameters 섹션의 예제:

parameters:

       -

          name: name

          label: Name

          description: Name of the application

          type: string

          required: true

       -

          name: ip

          label: IP Address

          description: The virtual IP address used for this application

          type: ipaddress

          required: true

      -

          name: svc-servers

          label: Servers

          type: object[]

          required: true

          parameters:

                   -

                      name: svc-ip

                      label: Server IP

                      description: The IP address of the server

                      type: ipaddress

                      required: true

                   -

                      name: svc-port

                      label: Server Port

                      description: The TCP port of the server

                      type: tcp-port

                      default: 80

      -

          name: lb-alg

          label: LoadBalancing Algorithm

          type: string

          allowed-values:

                - ROUNDROBIN

                - LEASTCONNECTION

          default: ROUNDROBIN

      -

          name: enable-healthcheck

          label: Enable HealthCheck?

          type: boolean

          default: true

다음은 이전 섹션에서 설명한 목록의 모든 특성과 값을 정의하는 예제입니다.

          name: features-list

          type: string[]

          min-length: 1

          max-length: 3

          min-items: 1

          max-items: 3

          pattern: "[A-Z]+"

          allowed-values:

             - SP

             - LB

             - CS

          default:

             - LB