139 lines
4.8 KiB
Python
139 lines
4.8 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2017, Ansible by Red Hat, inc
|
|
#
|
|
# This file is part of Ansible by Red Hat
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'core'}
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: net_user
|
|
version_added: "2.4"
|
|
author: "Trishna Guha (@trishnag)"
|
|
short_description: Manage the collection of local users on network device
|
|
description:
|
|
- This module provides declarative management of the local usernames
|
|
configured on network devices. It allows playbooks to manage
|
|
either individual usernames or the collection of usernames in the
|
|
current running config. It also supports purging usernames from the
|
|
configuration that are not explicitly defined.
|
|
options:
|
|
collection:
|
|
description:
|
|
- The set of username objects to be configured on the remote
|
|
network device. The list entries can either be the username
|
|
or a hash of username and properties. This argument is mutually
|
|
exclusive with the C(name) argument.
|
|
name:
|
|
description:
|
|
- The username to be configured on the remote network device.
|
|
This argument accepts a string value and is mutually exclusive
|
|
with the C(collection) argument.
|
|
Please note that this option is not same as C(provider username).
|
|
password:
|
|
description:
|
|
- The password to be configured on the remote network device. The
|
|
password needs to be provided in clear and it will be encrypted
|
|
on the device.
|
|
Please note that this option is not same as C(provider password).
|
|
update_password:
|
|
description:
|
|
- Since passwords are encrypted in the device running config, this
|
|
argument will instruct the module when to change the password. When
|
|
set to C(always), the password will always be updated in the device
|
|
and when set to C(on_create) the password will be updated only if
|
|
the username is created.
|
|
default: always
|
|
choices: ['on_create', 'always']
|
|
privilege:
|
|
description:
|
|
- The C(privilege) argument configures the privilege level of the
|
|
user when logged into the system. This argument accepts integer
|
|
values in the range of 1 to 15.
|
|
role:
|
|
description:
|
|
- Configures the role for the username in the
|
|
device running configuration. The argument accepts a string value
|
|
defining the role name. This argument does not check if the role
|
|
has been configured on the device.
|
|
sshkey:
|
|
description:
|
|
- Specifies the SSH public key to configure
|
|
for the given username. This argument accepts a valid SSH key value.
|
|
nopassword:
|
|
description:
|
|
- Defines the username without assigning
|
|
a password. This will allow the user to login to the system
|
|
without being authenticated by a password.
|
|
type: bool
|
|
purge:
|
|
description:
|
|
- Instructs the module to consider the
|
|
resource definition absolute. It will remove any previously
|
|
configured usernames on the device with the exception of the
|
|
`admin` user (the current defined set of users).
|
|
type: bool
|
|
default: false
|
|
state:
|
|
description:
|
|
- Configures the state of the username definition
|
|
as it relates to the device operational configuration. When set
|
|
to I(present), the username(s) should be configured in the device active
|
|
configuration and when set to I(absent) the username(s) should not be
|
|
in the device active configuration
|
|
default: present
|
|
choices: ['present', 'absent']
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- name: create a new user
|
|
net_user:
|
|
name: ansible
|
|
sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
|
|
state: present
|
|
- name: remove all users except admin
|
|
net_user:
|
|
purge: yes
|
|
- name: set multiple users to privilege level 15
|
|
net_user:
|
|
collection:
|
|
- name: netop
|
|
- name: netend
|
|
privilege: 15
|
|
state: present
|
|
- name: Change Password for User netop
|
|
net_user:
|
|
name: netop
|
|
password: "{{ new_password }}"
|
|
update_password: always
|
|
state: present
|
|
"""
|
|
|
|
RETURN = """
|
|
commands:
|
|
description: The list of configuration mode commands to send to the device
|
|
returned: always
|
|
type: list
|
|
sample:
|
|
- username ansible secret password
|
|
- username admin secret admin
|
|
"""
|