Try SpotterConfiguration for SSL service resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for SSL service resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | sslservice
delegate_to: localhost
netscaler.adc.sslservice:
state: present
servicename: nsrnatsip-127.0.0.1-5061
ersa: ENABLED
sessreuse: DISABLED
ssl3: DISABLED
tls1: DISABLED
tls11: DISABLED
dtls1: DISABLED
dh:
choices:
- ENABLED
- DISABLED
description:
- State of Diffie-Hellman (DH) key exchange. This parameter is not applicable when
configuring a backend service.
type: str
ersa:
choices:
- ENABLED
- DISABLED
description:
- State of Ephemeral RSA (eRSA) key exchange. Ephemeral RSA allows clients that support
only export ciphers to communicate with the secure server even if the server certificate
does not support export clients. The ephemeral RSA key is automatically generated
when you bind an export cipher to an SSL or TCP-based SSL virtual server or service.
When you remove the export cipher, the eRSA key is not deleted. It is reused at
a later date when another export cipher is bound to an SSL or TCP-based SSL virtual
server or service. The eRSA key is deleted when the appliance restarts.
- This parameter is not applicable when configuring a backend service.
type: str
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
ssl2:
choices:
- ENABLED
- DISABLED
description:
- State of SSLv2 protocol support for the SSL service.
- This parameter is not applicable when configuring a backend service.
type: str
ssl3:
choices:
- ENABLED
- DISABLED
description:
- State of SSLv3 protocol support for the SSL service.
- '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.
type: str
dtls1:
choices:
- ENABLED
- DISABLED
description:
- State of DTLSv1.0 protocol support for the SSL service.
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.
type: str
tls12:
choices:
- ENABLED
- DISABLED
description:
- State of TLSv1.2 protocol support for the SSL service.
type: str
tls13:
choices:
- ENABLED
- DISABLED
description:
- State of TLSv1.3 protocol support for the SSL service.
type: str
dhfile:
description:
- Name for and, optionally, path to the PEM-format DH parameter file to be installed.
/nsconfig/ssl/ is the default path. This parameter is not applicable when configuring
a backend service.
type: str
dtls12:
choices:
- ENABLED
- DISABLED
description:
- State of DTLSv1.2 protocol support for the SSL service.
type: str
dhcount:
description:
- Number of interactions, between the client and the Citrix ADC, after which the DH
private-public pair is regenerated. A value of zero (0) specifies refresh every
time. This parameter is not applicable when configuring a backend service. Allowed
DH count values are 0 and >= 500.
type: float
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
sslv2url:
description:
- URL of the page to which to redirect the client in case of a protocol version mismatch.
Typically, this page has a clear explanation of the error or an alternative location
that the transaction can continue from.
- This parameter is not applicable when configuring a backend service.
type: str
cipherurl:
description:
- URL of the page to which to redirect the client in case of a cipher mismatch. Typically,
this page has a clear explanation of the error or an alternative location that the
transaction can continue from.
- This parameter is not applicable when configuring a backend service.
type: str
ersacount:
description:
- Refresh count for regeneration of RSA public-key and private-key pair. Zero (0)
specifies infinite usage (no refresh).
- This parameter is not applicable when configuring a backend service.
type: float
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 virtual server and service-based
offload. 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
clientauth:
choices:
- ENABLED
- DISABLED
description:
- State of client authentication. In service-based SSL offload, the service terminates
the SSL handshake if the SSL client does not provide a valid certificate.
- This parameter is not applicable when configuring a backend service.
type: str
clientcert:
choices:
- Mandatory
- Optional
description:
- Type of client authentication. If this parameter is set to MANDATORY, the appliance
terminates the SSL handshake if the SSL client does not provide a valid certificate.
With the OPTIONAL setting, the appliance requests a certificate from the SSL clients
but proceeds with the SSL transaction even if the client presents an invalid certificate.
- This parameter is not applicable when configuring a backend SSL service.
- 'Caution: Define proper access control policies before changing this setting to
C(Optional).'
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.
type: str
sslprofile:
description:
- Name of the SSL profile that contains SSL settings for the service.
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
servicename:
description:
- Name of the SSL service.
type: str
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
sslredirect:
choices:
- ENABLED
- DISABLED
description:
- State of HTTPS redirects for the SSL service.
- ''
- For an SSL session, if the client browser receives a redirect message, the browser
tries to connect to the new location. However, the secure SSL session breaks if
the object has moved from a secure site (https://) to an unsecure site (http://).
Typically, a warning message appears on the screen, prompting the user to continue
or disconnect.
- If SSL Redirect is C(ENABLED), the redirect message is automatically converted from
http:// to https:// and the SSL session does not break.
- ''
- This parameter is not applicable when configuring a backend service.
type: str
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
sslv2redirect:
choices:
- ENABLED
- DISABLED
description:
- State of SSLv2 Redirect. If this parameter is set to C(ENABLED), you can configure
an SSL virtual server or service to display meaningful error messages if the SSL
handshake fails because of a protocol version mismatch between the virtual server
or service and the client.
- This parameter is not applicable when configuring a backend service.
type: str
cipherredirect:
choices:
- ENABLED
- DISABLED
description:
- State of Cipher Redirect. If this parameter is set to C(ENABLED), you can configure
an SSL virtual server or service to display meaningful error messages if the SSL
handshake fails because of a cipher mismatch between the virtual server or service
and the client.
- This parameter is not applicable when configuring a backend service.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
pushenctrigger:
choices:
- Always
- Merge
- Ignore
- Timer
description:
- 'Trigger encryption on the basis of the PUSH flag value. Available settings function
as follows:'
- '* ALWAYS - Any PUSH packet triggers encryption.'
- '* IGNORE - C(Ignore) PUSH packet for triggering encryption.'
- '* MERGE - For a consecutive sequence of PUSH packets, the last PUSH packet triggers
encryption.'
- '* TIMER - PUSH packet triggering encryption is delayed by the time defined in the
set ssl parameter command or in the Change Advanced SSL Settings dialog box.'
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
dtlsprofilename:
description:
- Name of the DTLS profile that contains DTLS settings for the service.
type: str
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
dhkeyexpsizelimit:
choices:
- ENABLED
- DISABLED
description:
- This option enables the use of NIST recommended (NIST Special Publication 800-56A)
bit size for private-key size. For example, for DH params of size 2048bit, the private-key
size recommended is 224bits. This is rounded-up to 256bits.
type: str
redirectportrewrite:
choices:
- ENABLED
- DISABLED
description:
- State of the port rewrite while performing HTTPS redirect. If this parameter is
set to C(ENABLED), and the URL from the server does not contain the standard port,
the port is rewritten to the standard.
type: str
strictsigdigestcheck:
choices:
- ENABLED
- DISABLED
description:
- Parameter indicating to check whether peer's certificate during TLS1.2 handshake
is signed with one of signature-hash combination supported by Citrix ADC
type: str
sslservice_ecccurve_binding:
description: Bindings for sslservice_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
sslservice_sslcipher_binding:
description: Bindings for sslservice_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
sslservice_sslpolicy_binding:
description: Bindings for sslservice_sslpolicy_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
sslservice_sslcertkey_binding:
description: Bindings for sslservice_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_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
sslservice_sslciphersuite_binding:
description: Bindings for sslservice_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
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
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