Class: Ansible::Ruby::Modules::Bigip_device_auth

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

Overview

Manage the system authentication configuration. This module can assist in configuring a number of different system authentication types. Note that this module can not be used to configure APM authentication types.

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

#authentication ⇒ :"use-first-server", ...

Returns Specifies the process the system employs when sending authentication requests.,When C(use-first-server), specifies that the system sends authentication attempts to only the first server in the list.,When C(use-all-servers), specifies that the system sends an authentication request to each server until authentication succeeds, or until the system has sent a request to all servers in the list.,This parameter is supported by the C(tacacs) type.

Returns:

  • (:"use-first-server", :"use-all-servers", nil) —

    Specifies the process the system employs when sending authentication requests.,When C(use-first-server), specifies that the system sends authentication attempts to only the first server in the list.,When C(use-all-servers), specifies that the system sends an authentication request to each server until authentication succeeds, or until the system has sent a request to all servers in the list.,This parameter is supported by the C(tacacs) type.



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

attribute :authentication

#protocol_name ⇒ :lcp, ...

Returns Specifies the protocol associated with the value specified in C(service_name), which is a subset of the associated service being used for client authorization or system accounting.,Note that the majority of TACACS+ implementations are of protocol type C(ip), so try that first.

Returns:

  • (:lcp, :ip, :ipx, :atalk, :vines, :lat, :xremote, :tn3270, :telnet, :rlogin, :pad, :vpdn, :ftp, :http, :deccp, :osicp, :unknown, nil) —

    Specifies the protocol associated with the value specified in C(service_name), which is a subset of the associated service being used for client authorization or system accounting.,Note that the majority of TACACS+ implementations are of protocol type C(ip), so try that first.



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

attribute :protocol_name

#secret ⇒ String?

Returns Secret key used to encrypt and decrypt packets sent or received from the server.,B(Do not) use the pound/hash sign in the secret for TACACS+ servers.,When configuring TACACS+ auth for the first time, this value is required.

Returns:

  • (String, nil) —

    Secret key used to encrypt and decrypt packets sent or received from the server.,B(Do not) use the pound/hash sign in the secret for TACACS+ servers.,When configuring TACACS+ auth for the first time, this value is required.



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

attribute :secret

#servers ⇒ Array<String>, ...

Returns Specifies a list of the IPv4 addresses for servers using the Terminal Access Controller Access System (TACACS)+ protocol with which the system communicates to obtain authorization data.,For each address, an alternate TCP port number may be optionally specified by specifying the C(port) key.,If no port number is specified, the default port C(49163) is used.,This parameter is supported by the C(tacacs) type.

Returns:

  • (Array<String>, String, nil) —

    Specifies a list of the IPv4 addresses for servers using the Terminal Access Controller Access System (TACACS)+ protocol with which the system communicates to obtain authorization data.,For each address, an alternate TCP port number may be optionally specified by specifying the C(port) key.,If no port number is specified, the default port C(49163) is used.,This parameter is supported by the C(tacacs) type.



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

attribute :servers

#service_name ⇒ :slip, ...

Returns Specifies the name of the service that the user is requesting to be authorized to use.,Identifying what the user is asking to be authorized for, enables the TACACS+ server to behave differently for different types of authorization requests.,When configuring this form of system authentication, this setting is required.,Note that the majority of TACACS+ implementations are of service type C(ppp), so try that first.

Returns:

  • (:slip, :ppp, :arap, :shell, :"tty-daemon", :connection, :system, :firewall, nil) —

    Specifies the name of the service that the user is requesting to be authorized to use.,Identifying what the user is asking to be authorized for, enables the TACACS+ server to behave differently for different types of authorization requests.,When configuring this form of system authentication, this setting is required.,Note that the majority of TACACS+ implementations are of service type C(ppp), so try that first.



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

attribute :service_name

#state ⇒ :absent, ...

Returns The state of the authentication configuration on the system.,When C(present), guarantees that the system is configured for the specified C(type).,When C(absent), sets the system auth source back to C(local).

Returns:

  • (:absent, :present, nil) —

    The state of the authentication configuration on the system.,When C(present), guarantees that the system is configured for the specified C(type).,When C(absent), sets the system auth source back to C(local).



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

attribute :state

#type ⇒ :tacacs, ...

Returns The authentication type to manage with this module.,Take special note that the parameters supported by this module will vary depending on the C(type) that you are configuring.,This module only supports a subset, at this time, of the total available auth types.

Returns:

  • (:tacacs, :local, nil) —

    The authentication type to manage with this module.,Take special note that the parameters supported by this module will vary depending on the C(type) that you are configuring.,This module only supports a subset, at this time, of the total available auth types.



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

attribute :type

#update_secret ⇒ :always, ...

Returns C(always) will allow to update secrets if the user chooses to do so.,C(on_create) will only set the secret when a C(use_auth_source) is C(yes) and TACACS+ is not currently the auth source.

Returns:

  • (:always, :on_create, nil) —

    C(always) will allow to update secrets if the user chooses to do so.,C(on_create) will only set the secret when a C(use_auth_source) is C(yes) and TACACS+ is not currently the auth source.



44
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_device_auth.rb', line 44

attribute :update_secret

#use_for_auth ⇒ Symbol?

Returns Specifies whether or not this auth source is put in use on the system.

Returns:

  • (Symbol, nil) —

    Specifies whether or not this auth source is put in use on the system.



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

attribute :use_for_auth