W3cubDocs

/Ansible

cisco.intersight.intersight_ntp_policy – NTP policy configuration for Cisco Intersight

Note

This plugin is part of the cisco.intersight collection (version 1.0.17).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.intersight.

To use it in a playbook, specify: cisco.intersight.intersight_ntp_policy.

New in version 2.10: of cisco.intersight

Synopsis

  • NTP policy configuration for Cisco Intersight.
  • Used to configure NTP servers and timezone settings on Cisco Intersight managed devices.
  • For more information see Cisco Intersight.

Parameters

Parameter Choices/Defaults Comments
api_key_id
string / required
Public API Key ID associated with the private key.
If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.
api_private_key
string / required
Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication.
If a string is used, Ansible vault should be used to encrypt string data.
Ex. ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file '-----BEGIN EC PRIVATE KEY-----
<your private key data>
-----END EC PRIVATE KEY-----'
If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.
api_uri
string
Default:
"https://intersight.com/api/v1"
URI used to access the Intersight API.
If not set, the value of the INTERSIGHT_API_URI environment variable is used.
description
string
The user-defined description of the NTP policy.
Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).

aliases: descr
enable
boolean
    Choices:
  • no
  • yes ←
Enable or disable NTP.
name
string / required
The name assigned to the NTP policy.
The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.
ntp_servers
list / elements=string
List of NTP servers configured on the endpoint.
organization
string
Default:
"default"
The name of the Organization this resource is assigned to.
Profiles and Policies that are created within a Custom Organization are applicable only to devices in the same Organization.
state
string
    Choices:
  • present ←
  • absent
If present, will verify the resource is present and will create if needed.
If absent, will verify the resource is absent and will delete if needed.
tags
list / elements=string
List of tags in Key:<user-defined key> Value:<user-defined value> format.
timezone
string
Timezone of services on the endpoint.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Boolean control for verifying the api_uri TLS certificate

Examples

- name: Configure NTP Policy
  cisco.intersight.intersight_ntp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-ntp
    description: NTP policy for lab use
    tags:
      - Key: Site
        Value: RCDN
    ntp_servers:
      - ntp.esl.cisco.com
    timezone: America/Chicago

- name: Delete NTP Policy
  cisco.intersight.intersight_ntp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: DevNet
    name: lab-ntp
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
api_repsonse
dictionary
always
The API response output returned by the specified resource.

Sample:
{'api_response': {'Name': 'lab-ntp', 'ObjectType': 'ntp.Policy', 'Tags': [{'Key': 'Site', 'Value': 'RCDN'}]}}


Authors

  • David Soper (@dsoper2)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/intersight/intersight_ntp_policy_module.html