netscaler / netscaler.adc / 2.5.1 / module / sslcertreq Configuration for certificate request resource. | "added in version" 2.0.0 of netscaler.adc" Authors: Sumanth Lingappa (@sumanth-lingappa) preview | supported by communitynetscaler.adc.sslcertreq (2.5.1) — module
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections: - name: netscaler.adc version: 2.5.1
Configuration for certificate request resource.
- name: Create ssl certReq certname.csr delegate_to: localhost netscaler.adc.sslcertreq: state: created reqfile: certname.csr keyfile: certname.key keyform: PEM countryname: IN statename: KAR organizationname: example commonname: example emailaddress: test1@example.com
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 state: choices: - created default: present description: - The state of the resource being configured by the module on the NetScaler ADC node. - When C(created), the `create` operation will be applied on the resource. type: str keyfile: description: - Name of and, optionally, path to the private key used to create the certificate signing request, which then becomes part of the certificate-key pair. The private key can be either an RSA or a DSA key. The key must be present in the appliance's local storage. /nsconfig/ssl is the default path. type: str keyform: choices: - DER - PEM description: - Format in which the key is stored on the appliance. type: str reqfile: description: - Name for and, optionally, path to the certificate signing request (CSR). /nsconfig/ssl/ is the default path. 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 statename: description: - Full name of the state or province where your organization is located. - Do not abbreviate. type: str commonname: description: - Fully qualified domain name for the company or web site. The common name must match the name used by DNS servers to do a DNS lookup of your server. Most browsers use this information for authenticating the server's certificate during the SSL handshake. If the server name in the URL does not match the common name as given in the server certificate, the browser terminates the SSL handshake or prompts the user with a warning message. - Do not use wildcard characters, such as asterisk (*) or question mark (?), and do not use an IP address as the common name. The common name must not contain the protocol specifier <http://> or <https://>. 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 companyname: description: - Additional name for the company or web site. type: str countryname: description: - Two letter ISO code for your country. For example, US for United States. type: str fipskeyname: description: - Name of the FIPS key used to create the certificate signing request. FIPS keys are created inside the Hardware Security Module of the FIPS card. 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 digestmethod: choices: - SHA1 - SHA256 description: - Digest algorithm used in creating CSR type: str emailaddress: description: - Contact person's e-mail address. This address is publically displayed as part of the certificate. Provide an e-mail address that is monitored by an administrator who can be contacted about the certificate. type: str localityname: description: - Name of the city or town in which your organization's head office is located. type: str pempassphrase: description: - '0' type: str nitro_protocol: choices: - http - https default: https description: - Which protocol to use when accessing the nitro API objects. type: str subjectaltname: description: - 'Subject Alternative Name (SAN) is an extension to X.509 that allows various values to be associated with a security certificate using a subjectAltName field. These values are called "Subject Alternative Names" (SAN). Names include:' - ' 1. Email addresses' - ' 2. IP addresses' - ' 3. URIs' - ' 4. DNS names (this is usually also provided as the Common Name RDN within the Subject field of the main certificate.)' - ' 5. Directory names (alternative Distinguished Names to that given in the Subject)' 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 nitro_auth_token: description: - The authentication token provided by a login operation. type: str version_added: 2.6.0 version_added_collection: netscaler.adc organizationname: description: - Name of the organization that will use this certificate. The organization name (corporation, limited partnership, university, or government agency) must be registered with some authority at the national, state, or city level. Use the legal name under which the organization is registered. - 'Do not abbreviate the organization name and do not use the following characters in the name:' - Angle brackets (< >) tilde (~), exclamation mark, at (@), pound (#), zero (0), caret (^), asterisk (*), forward slash (/), square brackets ([ ]), question mark (?). type: str challengepassword: description: - Pass phrase, embedded in the certificate signing request that is shared only between the client or server requesting the certificate and the SSL certificate issuer (typically the certificate authority). This pass phrase can be used to authenticate a client or server that is requesting a certificate from the certificate authority. type: str organizationunitname: description: - Name of the division or section in the organization that will use the certificate. type: str
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