netscaler.adc.sslservicegroup (2.5.1) — module

Configuration for SSL service group resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1


Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for SSL service group resource.

Inputs

    
nsip:
    description:
    - The ip address of the NetScaler ADC appliance where the nitro API calls will be
      made.
    - The port can be specified with the colon (:). E.g. 192.168.1.1:555.
    required: true
    type: str

ssl3:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of SSLv3 protocol support for the SSL service group.
    - 'Note: On platforms with SSL acceleration chips, if the SSL chip does not support
      SSLv3, this parameter cannot be set to C(ENABLED).'
    type: str

tls1:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of TLSv1.0 protocol support for the SSL service group.
    type: str

state:
    choices:
    - present
    - unset
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(present), the resource will be added/updated configured according to the
      module's parameters.
    - When C(unset), the resource will be unset on the NetScaler ADC node.
    type: str

tls11:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of TLSv1.1 protocol support for the SSL service group.
    type: str

tls12:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of TLSv1.2 protocol support for the SSL service group.
    type: str

tls13:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of TLSv1.3 protocol support for the SSL service group.
    type: str

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

sessreuse:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of session reuse. Establishing the initial handshake requires CPU-intensive
      public key encryption operations. With the C(ENABLED) setting, session key exchange
      is avoided for session resumption requests received from the client.
    type: str

snienable:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of the Server Name Indication (SNI) feature on the service. SNI helps to enable
      SSL encryption on multiple domains on a single virtual server or service if the
      domains are controlled by the same organization and share the same second-level
      domain name. For example, *.sports.net can be used to secure domains such as login.sports.net
      and help.sports.net.
    type: str

commonname:
    description:
    - Name to be checked against the CommonName (CN) field in the server certificate bound
      to the SSL server
    type: str

nitro_pass:
    description:
    - The password with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

nitro_user:
    description:
    - The username with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

serverauth:
    choices:
    - ENABLED
    - DISABLED
    description:
    - State of server authentication support for the SSL service group.
    type: str

sslprofile:
    description:
    - Name of the SSL profile that contains SSL settings for the Service Group.
    type: str

save_config:
    default: false
    description:
    - If C(true) the module will save the configuration on the NetScaler ADC node if it
      makes any changes.
    - The module will not save the configuration on the NetScaler ADC node if it made
      no changes.
    type: bool

sesstimeout:
    description:
    - Time, in seconds, for which to keep the session active. Any session resumption request
      received after the timeout period will require a fresh SSL handshake and establishment
      of a new SSL session.
    type: float

ocspstapling:
    choices:
    - ENABLED
    - DISABLED
    description:
    - 'State of OCSP stapling support on the SSL virtual server. Supported only if the
      protocol used is higher than SSLv3. Possible values:'
    - 'C(ENABLED): The appliance sends a request to the OCSP responder to check the status
      of the server certificate and caches the response for the specified time. If the
      response is valid at the time of SSL handshake with the client, the OCSP-based server
      certificate status is sent to the client during the handshake.'
    - 'C(DISABLED): The appliance does not check the status of the server certificate.'
    type: str

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    required: false
    type: bool

sendclosenotify:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Enable sending SSL Close-Notify at the end of a transaction
    type: str

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

servicegroupname:
    description:
    - Name of the SSL service group for which to set advanced configuration.
    type: str

strictsigdigestcheck:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Parameter indicating to check whether peer's certificate is signed with one of signature-hash
      combination supported by Citrix ADC
    type: str

sslservicegroup_ecccurve_binding:
    description: Bindings for sslservicegroup_ecccurve_binding resource
    suboptions:
      binding_members:
        default: []
        description: List of binding members
        elements: dict
        type: list
      mode:
        choices:
        - desired
        - bind
        - unbind
        default: desired
        description:
        - The mode in which to configure the bindings.
        - If mode is set to C(desired), the bindings will be added or removed from the
          target NetScaler ADCs as necessary to match the bindings specified in the state.
        - If mode is set to C(bind), the specified bindings will be added to the resource.
          The existing bindings in the target ADCs will not be modified.
        - If mode is set to C(unbind), the specified bindings will be removed from the
          resource. The existing bindings in the target ADCs will not be modified.
        type: str
    type: dict

sslservicegroup_sslcipher_binding:
    description: Bindings for sslservicegroup_sslcipher_binding resource
    suboptions:
      binding_members:
        default: []
        description: List of binding members
        elements: dict
        type: list
      mode:
        choices:
        - desired
        - bind
        - unbind
        default: desired
        description:
        - The mode in which to configure the bindings.
        - If mode is set to C(desired), the bindings will be added or removed from the
          target NetScaler ADCs as necessary to match the bindings specified in the state.
        - If mode is set to C(bind), the specified bindings will be added to the resource.
          The existing bindings in the target ADCs will not be modified.
        - If mode is set to C(unbind), the specified bindings will be removed from the
          resource. The existing bindings in the target ADCs will not be modified.
        type: str
    type: dict

sslservicegroup_sslcertkey_binding:
    description: Bindings for sslservicegroup_sslcertkey_binding resource
    suboptions:
      binding_members:
        default: []
        description: List of binding members
        elements: dict
        type: list
      mode:
        choices:
        - desired
        - bind
        - unbind
        default: desired
        description:
        - The mode in which to configure the bindings.
        - If mode is set to C(desired), the bindings will be added or removed from the
          target NetScaler ADCs as necessary to match the bindings specified in the state.
        - If mode is set to C(bind), the specified bindings will be added to the resource.
          The existing bindings in the target ADCs will not be modified.
        - If mode is set to C(unbind), the specified bindings will be removed from the
          resource. The existing bindings in the target ADCs will not be modified.
        type: str
    type: dict

sslservicegroup_sslciphersuite_binding:
    description: Bindings for sslservicegroup_sslciphersuite_binding resource
    suboptions:
      binding_members:
        default: []
        description: List of binding members
        elements: dict
        type: list
      mode:
        choices:
        - desired
        - bind
        - unbind
        default: desired
        description:
        - The mode in which to configure the bindings.
        - If mode is set to C(desired), the bindings will be added or removed from the
          target NetScaler ADCs as necessary to match the bindings specified in the state.
        - If mode is set to C(bind), the specified bindings will be added to the resource.
          The existing bindings in the target ADCs will not be modified.
        - If mode is set to C(unbind), the specified bindings will be removed from the
          resource. The existing bindings in the target ADCs will not be modified.
        type: str
    type: dict

Outputs

changed:
  description: Indicates if any change is made by the module
  returned: always
  sample: true
  type: bool
diff:
  description: Dictionary of before and after changes
  returned: always
  sample:
    after:
      key2: pqr
    before:
      key1: xyz
    prepared: changes done
  type: dict
diff_list:
  description: List of differences between the actual configured object and the configuration
    specified in the module
  returned: when changed
  sample:
  - 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
    PQR'
  type: list
failed:
  description: Indicates if the module failed or not
  returned: always
  sample: false
  type: bool
loglines:
  description: list of logged messages by the module
  returned: always
  sample:
  - message 1
  - message 2
  type: list