Skip to content

Latest commit

 

History

History
124 lines (98 loc) · 7.42 KB

README.md

File metadata and controls

124 lines (98 loc) · 7.42 KB
Raw

NTP role

This role facilitates the configuration of network time protocol (NTP) attributes. It specifically enables configuration of NTP server, NTP source, authentication, and broadcast service. This role is abstracted for Dell EMC PowerSwitch platforms running Dell EMC SmartFabric OS10.

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

Role variables

  • Role is abstracted using the ansible_network_os variable that can take dellemc.os10.os10 as the value
  • If os10_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

os10_ntp keys

Key Type Description Support
server list Configures the NTP server (see server.*) os10
server.ip string (required) Configures an IPv4 address for the NTP server (A.B.C.D format) os10
server.key integer Configures the peer authentication key for the NTP server os10
server.prefer boolean Configures the peer preference os10
server.state string: absent,present* Deletes the NTP server if set to absent os10
source string Configures the interface for the source address os10
master integer Configures the local clock to act as the server os10
authenticate boolean Configures authenticate time sources os10
authentication_key list Configures authentication key for trusted time sources (see authentication_key.*) os10
authentication_key.key_num integer Configures authentication key number os10
authentication_key.key_string_type integer: 0,9 Configures hidden authentication key string if the value is 9, and configures unencrypted authentication key string if the value is 0 os10
authentication_key.key_string string Configures the authentication key string os10
authentication_key.type string: md5,sha1,sha2-256 Configures the authentication type os10
authentication_key.state string: absent,present* Deletes the authenticaton key if set to absent os10
trusted_key list Configures key numbers for trusted time sources (see trusted_key.*) os10
trusted_key.key_num integer Configures the key number os10
trusted_key.state string: absent,present* Deletes the trusted key if set to absent os10
intf dictionary Configures NTP on the interface (see intf.*) os10
intf.<interface name> dictionary Configures NTP on the interface (see <interface name>.*) os10
<interface name>.disable boolean Configures NTP disable on the interface os10
<interface name>.broadcast boolean Configures NTP broadcast client service on the interface os10
vrf dictionary Enables NTP on VRF (see vrf.*) os10
vrf.name string Name of the VRF to enable NTP os10
vrf.state string: absent,present* Disables NTP on the VRF if set to absent os10

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

Connection variables

Ansible Dell EMC network 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 os10, null* Loads the correct terminal and cliconf plugins to communicate with the remote device

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

Example playbook

This example uses the os10_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 OS10 name.

When the os10_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 os10_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 os10.

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: dellemc.os10.os10
build_dir: ../temp/os10
  
os10_ntp:
  source: ethernet 1/1/2
  master: 5
  authenticate: true
  authentication_key:
    - key_num: 123
      key_string_type: 9
      key_string: test
      type: md5
      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
  vrf:
    name: red
    state: present

Simple playbook to setup NTP — leaf.yaml

- hosts: leaf1
  roles:
     - dellemc.os10.os10_ntp

Run

ansible-playbook -i hosts leaf.yaml

(c) 2017-2020 Dell Inc. or its subsidiaries. All rights reserved.