dellos-ntp

NTP role

This role facilitates the configuration of network time protocol (NTP) attributes. This role is abstracted for dellos6, dellos9, and dellos10. It specifically enables configuration of NTP server for all three dellos and NTP source, authentication and broadcast service in dellos10.

The NTP role requires an SSH connection for connectivity to a Dell EMC Networking device. You can use any of the built-in OS connection variables .

Installation

ansible-galaxy install Dell-Networking.dellos-ntp

Role variables

  • Role is abstracted using the ansible_network_os variable that can take dellos9, dellos6, and dellos10 values
  • If dellos_cfg_generate is set to true, the variable generates the role configuration commands in a file
  • Any role variable with a corresponding state variable set to absent negates the configuration of that variable
  • Setting an empty value for any variable negates the corresponding configuration
  • Variables and values are case-sensitive

dellos_ntp keys

Key Type Description Support
server list Configures the NTP server (see server.*) dellos6, dellos9, dellos10
server.ip string (required) Configures an IPv4 address for the NTP server (A.B.C.D format) dellos6, dellos9, dellos10
server.key integer Configures the peer authentication key for the NTP server dellos10
server.prefer boolean Configures the peer preference dellos10
server.vrf list Configures the NTP server for VRF instance; list item contains the names of the VRF instance dellos9
server.state string: absent,present* Deletes the NTP server if set to absent dellos6, dellos9, dellos10
source string Configures the interface for the source address dellos10
master integer Configures the local clock to act as the server dellos10
authenticate boolean Configures authenticate time sources dellos10
authentication_key list Configures authentication key for trusted time sources (see authentication_key.*) dellos10
authentication_key.key_num integer Configures authentication key number dellos10
authentication_key.key_string_type integer: 0,7 Configures hidden authentication key string if the value is 7, and configures unencrypted authentication key string if the value is 0 dellos10
authentication_key.key_string string Configures the authentication key string dellos10
authentication_key.state string: absent,present* Deletes the authenticaton key if set to absent dellos10
trusted_key list Configures key numbers for trusted time sources (see trusted_key.*) dellos10
trusted_key.key_num integer Configures the key number dellos10
trusted_key.state string: absent,present* Deletes the trusted key if set to absent dellos10
intf dictionary Configures NTP on the interface (see intf.*) dellos10
intf.<interface name> dictionary Configures NTP on the interface (see <interface name>.*) dellos10
<interface name>.disable boolean Configures NTP disable on the interface dellos10
<interface name>.broadcast boolean Configures NTP broadcast client service on the interface dellos10

NOTE: Asterisk (*) denotes the default value if none is specified.

Connection variables

Ansible Dell EMC Networking roles require connection information to establish communication with the nodes in your inventory. This information can exist in the Ansible group_vars or host_vars directories or inventory or in the playbook itself.

Key Required Choices Description
ansible_host yes Specifies the hostname or address for connecting to the remote device over the specified transport
ansible_port no Specifies the port used to build the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_PORT option is used; it defaults to 22
ansible_ssh_user no Specifies the username that authenticates the CLI login for the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_USER environment variable value is used
ansible_ssh_pass no Specifies the password that authenticates the connection to the remote device
ansible_become no yes, no* Instructs the module to enter privileged mode on the remote device before sending any commands; if value is unspecified, the ANSIBLE_BECOME environment variable value is used, and the device attempts to execute all commands in non-privileged mode
ansible_become_method no enable, sudo* Instructs the module to allow the become method to be specified for handling privilege escalation; if value is unspecified, the ANSIBLE_BECOME_METHOD environment variable value is used
ansible_become_pass no Specifies the password to use if required to enter privileged mode on the remote device; if ansible_become is set to no this key is not applicable
ansible_network_os yes dellos6/dellos9/dellos10, null* Loads the correct terminal and cliconf plugins to communicate with the remote device

NOTE: Asterisk (*) denotes the default value if none is specified.

Dependencies

The dellos-ntp role is built on modules included in the core Ansible code. These modules were added in Ansible version 2.2.0.

Example playbook

This example uses the dellos-ntp role to set the NTP server, source ip, authentication and broadcast service. It creates a hosts file with the switch details and corresponding variables. The hosts file should define the ansible_network_os variable with corresponding Dell EMC networking OS name. When the dellos_cfg_generate variable is set to true, it generates the configuration commands as a .part file in build_dir path. By default it is set to false. The example writes a simple playbook that only references the dellos-ntp role.

By including the role, you automatically get access to all of the tasks to configure NTP attributes. The sample host_vars is for dellos10.

Sample hosts file

leaf1 ansible_host= <ip_address> 

Sample host_vars/leaf1

host: leaf1
ansible_ssh_user: xxxxx
ansible_ssh_pass: xxxxx
ansible_network_os: dellos10
build_dir: ../temp/dellos10
  
dellos_ntp:
  source: ethernet 1/1/2
  master: 5
  authenticate: true
  authentication_key:
    - key_num: 123
      key_string_type: 7
      key_string: test
      state: present
  trusted_key:
    - key_num: 1323
      state: present
  server:
    - ip: 2.2.2.2
      key: 345
      prefer: true
      state: present
  intf:
    ethernet 1/1/2:
      disable: true
      broadcast: true

Simple playbook to setup NTP - leaf.yaml

- hosts: leaf1
  roles:
     - Dell-Networking.dellos-ntp

Run

ansible-playbook -i hosts leaf.yaml

(c) 2017 Dell Inc. or its subsidiaries. All Rights Reserved.

About

The dellos-ntp role facilitates the configuration of NTP attributes in devices running Dell EMC Networking Operating Systems.

Install
ansible-galaxy install Dell-Networking/ansible-role-dellos-ntp
GitHub repository
License
apache-2.0
Downloads
68068