Class: Ansible::Ruby::Modules::Bigip_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb

Overview

Manage user accounts and user attributes on a BIG-IP. Typically this module operates only on the REST API users and not the CLI users. When specifying C(root), you may only change the password. Your other parameters will be ignored in this case. Changing the C(root) password is not an idempotent operation. Therefore, it will change it every time this module attempts to change it.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#full_name ⇒ String?

Returns Full name of the user.

Returns:

  • (String, nil) —

    Full name of the user.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 12

attribute :full_name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



40
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 40

attribute :partition

#partition_access ⇒ String?

Returns Specifies the administrative partition to which the user has access. C(partition_access) is required when creating a new account. Should be in the form “partition:role”. Valid roles include C(acceleration-policy-editor), C(admin), C(application-editor), C(auditor) C(certificate-manager), C(guest), C(irule-manager), C(manager), C(no-access) C(operator), C(resource-admin), C(user-manager), C(web-application-security-administrator), and C(web-application-security-editor). Partition portion of tuple should be an existing partition or the value ‘all’.

Returns:

  • (String, nil) —

    Specifies the administrative partition to which the user has access. C(partition_access) is required when creating a new account. Should be in the form “partition:role”. Valid roles include C(acceleration-policy-editor), C(admin), C(application-editor), C(auditor) C(certificate-manager), C(guest), C(irule-manager), C(manager), C(no-access) C(operator), C(resource-admin), C(user-manager), C(web-application-security-administrator), and C(web-application-security-editor). Partition portion of tuple should be an existing partition or the value ‘all’.



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 28

attribute :partition_access

#password_credential ⇒ String?

Returns Set the users password to this unencrypted value. C(password_credential) is required when creating a new account.

Returns:

  • (String, nil) —

    Set the users password to this unencrypted value. C(password_credential) is required when creating a new account.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 20

attribute :password_credential

#shell ⇒ :bash, ...

Returns Optionally set the users shell.

Returns:

  • (:bash, :none, :tmsh, nil) —

    Optionally set the users shell.



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 24

attribute :shell

#state ⇒ :present, ...

Returns Whether the account should exist or not, taking action if the state is different from what is stated.

Returns:

  • (:present, :absent, nil) —

    Whether the account should exist or not, taking action if the state is different from what is stated.



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 32

attribute :state

#update_password ⇒ :always, ...

Returns C(always) will allow to update passwords if the user chooses to do so. C(on_create) will only set the password for newly created users. When C(username_credential) is C(root), this value will be forced to C(always).

Returns:

  • (:always, :on_create, nil) —

    C(always) will allow to update passwords if the user chooses to do so. C(on_create) will only set the password for newly created users. When C(username_credential) is C(root), this value will be forced to C(always).



36
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 36

attribute :update_password

#username_credential ⇒ String

Returns Name of the user to create, remove or modify.,The C(root) user may not be removed.

Returns:

  • (String) —

    Name of the user to create, remove or modify.,The C(root) user may not be removed.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_user.rb', line 16

attribute :username_credential