W3cubDocs

/Ansible 2.10

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

Note

This plugin is part of the cisco.intersight collection.

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.
api_private_key
path / required
Filename (absolute path) of a PEM formatted file that contains your private key to be used for Intersight API authentication.
api_uri
string
Default:
"https://intersight.com/api/v1"
URI used to access the Intersight API.
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/intersight/intersight_ntp_policy_module.html