Dell-Networking.dellos-system
System Role
Overview
This role helps configure general system settings for Dell OS versions 6, 9, and 10. It lets you set the hostname and enable password for all three versions. Additionally, Dell OS 9 allows you to configure management route, hash algorithm, clock, terminal lines, banners, and reload types.
Requirements
To use the Dell system role, you need to connect via SSH to a Dell EMC networking device. You can use any of the standard Ansible connection variables.
Installation
To install the role, use the following command:
ansible-galaxy install Dell-Networking.dellos-system
Role Variables
- The role uses the
ansible_network_os
variable, which can be set todellos9
,dellos6
, ordellos10
. - If
dellos_cfg_generate
is set to true, it will generate configuration commands in a file. - Setting a variable to absent removes that configuration.
- Empty values for variables also negate the configuration.
- Variables are case-sensitive.
Key Variables
Key | Type | Description | Supported OS |
---|---|---|---|
hostname |
string | Sets the device's hostname | dellos9, dellos6, dellos10 |
unique_hostname |
boolean | Enables a unique hostname on the switch | dellos9 |
enable_password |
string | Sets the enable password | dellos6, dellos9 |
mtu |
integer | Sets the MTU for all interfaces | dellos6 |
... | ... | ... | ... |
Note: An asterisk (*) indicates a default value if none is specified.
Connection Variables
Ansible requires connection details to communicate with devices in your inventory. These can be placed in group_vars
, host_vars
, or directly in your playbook.
Key | Required | Choices | Description |
---|---|---|---|
ansible_host |
yes | Hostname or address of the remote device | |
ansible_port |
no | Port for the connection, defaults to 22 if unspecified | |
ansible_ssh_user |
no | Username for SSH login | |
ansible_ssh_pass |
no | Password for SSH login | |
ansible_become |
no | yes, no* | Switch to privileged mode before commands; defaults to no |
ansible_network_os |
yes | dellos6/dellos9/dellos10, null* | Loads correct plugins to communicate with the device |
Note: An asterisk (*) indicates a default value if none is specified.
Dependencies
The dellos-system
role uses modules found in core Ansible, available since version 2.2.0.
Example Playbook
Here’s a simple playbook to configure various settings such as NTP server, hostname, enable password, management route, and more.
Sample Hosts File
leaf1 ansible_host=<ip_address>
Sample Host Variables (host_vars/leaf1
)
hostname: leaf1
ansible_become: yes
ansible_ssh_user: xxxxx
ansible_ssh_pass: xxxxx
ansible_network_os: dellos9
dellos_system:
hostname: host1
enable_password: dell
...
Basic Playbook (leaf.yaml
)
- hosts: leaf1
roles:
- Dell-Networking.dellos-system
Running the Playbook
To execute the playbook, use the following command:
ansible-playbook -i hosts leaf.yaml
(c) 2017 Dell Inc. or its subsidiaries. All Rights Reserved.
The dellos-system role facilitates the configuration of system attributes in devices running Dell EMC Networking Operating Systems.
ansible-galaxy install Dell-Networking.dellos-system