netscaler.adc.ntpserver (2.5.1) — module

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 NTP server resource.

Inputs

    
key:
    description:
    - Key to use for encrypting authentication fields. All packets sent to and received
      from the server must include authentication fields encrypted by using this key.
      To require authentication for communication with the server, you must set either
      the value of this parameter or the autokey parameter.
    type: float

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:
    - present
    - absent
    - 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(absent), the resource will be deleted from the NetScaler ADC node.
    - When C(unset), the resource will be unset on the NetScaler ADC node.
    type: str

autokey:
    description:
    - Use the Autokey protocol for key management for this server, with the cryptographic
      values (for example, symmetric key, host and public certificate files, and sign
      key) generated by the ntp-keygen utility. To require authentication for communication
      with the server, you must set either the value of this parameter or the key parameter.
    type: bool

maxpoll:
    description:
    - Maximum time after which the NTP server must poll the NTP messages. In seconds,
      expressed as a power of 2.
    type: float

minpoll:
    description:
    - Minimum time after which the NTP server must poll the NTP messages. In seconds,
      expressed as a power of 2.
    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

serverip:
    description:
    - IP address of the NTP 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

servername:
    description:
    - Fully qualified domain name of the NTP server.
    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

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

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

preferredntpserver:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Preferred NTP server. The Citrix ADC chooses this NTP server for time synchronization
      among a set of correctly operating hosts.
    type: str

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