Class: Ansible::Ruby::Modules::Netscaler_ssl_certkey

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb

Overview

Manage ssl cerificate keys.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#cert ⇒ String?

Returns Name of and, optionally, path to the X509 certificate file that is used to form the certificate-key pair. The certificate file should be present on the appliance’s hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.,Minimum length = 1.

Returns:

  • (String, nil) —

    Name of and, optionally, path to the X509 certificate file that is used to form the certificate-key pair. The certificate file should be present on the appliance’s hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.,Minimum length = 1



16
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 16

attribute :cert

#certkey ⇒ String?

Returns Name for the certificate and private-key pair. Must begin with an ASCII alphanumeric or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space C( ), colon C(:), at C(@), equals C(=), and hyphen C(-) characters. Cannot be changed after the certificate-key pair is created.,The following requirement applies only to the NetScaler CLI:,If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my cert” or ‘my cert’).,Minimum length = 1.

Returns:

  • (String, nil) —

    Name for the certificate and private-key pair. Must begin with an ASCII alphanumeric or underscore C(_) character, and must contain only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space C( ), colon C(:), at C(@), equals C(=), and hyphen C(-) characters. Cannot be changed after the certificate-key pair is created.,The following requirement applies only to the NetScaler CLI:,If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my cert” or ‘my cert’).,Minimum length = 1



12
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 12

attribute :certkey

#expirymonitor ⇒ :enabled, ...

Returns Issue an alert when the certificate is about to expire.

Returns:

  • (:enabled, :disabled, nil) —

    Issue an alert when the certificate is about to expire.



36
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 36

attribute :expirymonitor

#inform ⇒ :DER, ...

Returns Input format of the certificate and the private-key files. The three formats supported by the appliance are:,PEM - Privacy Enhanced Mail,DER - Distinguished Encoding Rule,PFX - Personal Information Exchange.

Returns:

  • (:DER, :PEM, :PFX, nil) —

    Input format of the certificate and the private-key files. The three formats supported by the appliance are:,PEM - Privacy Enhanced Mail,DER - Distinguished Encoding Rule,PFX - Personal Information Exchange.



28
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 28

attribute :inform

#key ⇒ String?

Returns Name of and, optionally, path to the private-key file that is used to form the certificate-key pair. The certificate file should be present on the appliance’s hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.,Minimum length = 1.

Returns:

  • (String, nil) —

    Name of and, optionally, path to the private-key file that is used to form the certificate-key pair. The certificate file should be present on the appliance’s hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.,Minimum length = 1



20
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 20

attribute :key

#notificationperiod ⇒ Integer?

Returns Time, in number of days, before certificate expiration, at which to generate an alert that the certificate is about to expire.,Minimum value = C(10),Maximum value = C(100).

Returns:

  • (Integer, nil) —

    Time, in number of days, before certificate expiration, at which to generate an alert that the certificate is about to expire.,Minimum value = C(10),Maximum value = C(100)



40
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 40

attribute :notificationperiod

#passplain ⇒ String?

Returns Pass phrase used to encrypt the private-key. Required when adding an encrypted private-key in PEM format.,Minimum length = 1.

Returns:

  • (String, nil) —

    Pass phrase used to encrypt the private-key. Required when adding an encrypted private-key in PEM format.,Minimum length = 1



32
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 32

attribute :passplain

#password ⇒ Boolean?

Returns Passphrase that was used to encrypt the private-key. Use this option to load encrypted private-keys in PEM format.

Returns:

  • (Boolean, nil) —

    Passphrase that was used to encrypt the private-key. Use this option to load encrypted private-keys in PEM format.



24
 
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_ssl_certkey.rb', line 24

attribute :password