Class: Ansible::Ruby::Modules::Junos_user
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Junos_user
- Defined in:
- lib/ansible/ruby/modules/generated/network/junos/junos_user.rb
Overview
This module manages locally configured user accounts on remote network devices running the JUNOS operating system. It provides a set of arguments for creating, removing and updating locally defined accounts
Instance Method Summary collapse
-
#active ⇒ :yes, ...
Specifies whether or not the configuration is active or deactivated.
-
#aggregate ⇒ Array<Hash>, ...
The C(aggregate) argument defines a list of users to be configured on the remote device.
-
#full_name ⇒ Object?
The C(full_name) argument provides the full name of the user account to be created on the remote device.
-
#name ⇒ String?
The C(name) argument defines the username of the user to be created on the system.
-
#purge ⇒ :yes, ...
The C(purge) argument instructs the module to consider the users definition absolute.
-
#role ⇒ :operator, ...
The C(role) argument defines the role of the user account on the remote system.
-
#sshkey ⇒ String?
The C(sshkey) argument defines the public SSH key to be configured for the user account on the remote system.
-
#state ⇒ :present, ...
The C(state) argument configures the state of the user definitions as it relates to the device operational configuration.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#active ⇒ :yes, ...
Returns Specifies whether or not the configuration is active or deactivated.
39 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 39 attribute :active |
#aggregate ⇒ Array<Hash>, ...
Returns The C(aggregate) argument defines a list of users to be configured on the remote device. The list of users will be compared against the current users and only changes will be added or removed from the device configuration. This argument is mutually exclusive with the name argument.
12 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 12 attribute :aggregate |
#full_name ⇒ Object?
Returns The C(full_name) argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
20 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 20 attribute :full_name |
#name ⇒ String?
Returns The C(name) argument defines the username of the user to be created on the system. This argument must follow appropriate usernaming conventions for the target device running JUNOS. This argument is mutually exclusive with the C(aggregate) argument.
16 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 16 attribute :name |
#purge ⇒ :yes, ...
Returns The C(purge) argument instructs the module to consider the users definition absolute. It will remove any previously configured users on the device with the exception of the current defined set of aggregate.
31 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 31 attribute :purge |
#role ⇒ :operator, ...
Returns The C(role) argument defines the role of the user account on the remote system. User accounts can have more than one role configured.
23 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 23 attribute :role |
#sshkey ⇒ String?
Returns The C(sshkey) argument defines the public SSH key to be configured for the user account on the remote system. This argument must be a valid SSH key.
27 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 27 attribute :sshkey |
#state ⇒ :present, ...
Returns The C(state) argument configures the state of the user definitions as it relates to the device operational configuration. When set to I(present), the user should be configured in the device active configuration and when set to I(absent) the user should not be in the device active configuration.
35 |
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_user.rb', line 35 attribute :state |