Class: Ansible::Ruby::Modules::Bigip_snmp_community

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

Overview

Assists in managing SNMP communities on a BIG-IP. Different SNMP versions are supported by this module. Take note of the different parameters offered by this module, as different parameters work for different versions of SNMP. Typically this becomes an interest if you are mixing versions C(v2c) and C(3).

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

#access ⇒ :ro, ...

Returns Specifies the user’s access level to the MIB.,When creating a new community, if this parameter is not specified, the default is C(ro).,When C(ro), specifies that the user can view the MIB, but cannot modify the MIB.,When C(rw), specifies that the user can view and modify the MIB.

Returns:

  • (:ro, :rw, :"read-only", :"read-write", nil) —

    Specifies the user’s access level to the MIB.,When creating a new community, if this parameter is not specified, the default is C(ro).,When C(ro), specifies that the user can view the MIB, but cannot modify the MIB.,When C(rw), specifies that the user can view and modify the MIB.



38
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 38

attribute :access

#community ⇒ Object?

Returns Specifies the community string (password) for access to the MIB.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.

Returns:

  • (Object, nil) —

    Specifies the community string (password) for access to the MIB.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.



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

attribute :community

#ip_version ⇒ 4, ...

Returns Specifies whether the record applies to IPv4 or IPv6 addresses.,When creating a new community, if this value is not specified, the default of C(4) will be used.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.

Returns:

  • (4, 6, nil) —

    Specifies whether the record applies to IPv4 or IPv6 addresses.,When creating a new community, if this value is not specified, the default of C(4) will be used.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.



42
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 42

attribute :ip_version

#name ⇒ String?

Returns Name that identifies the SNMP community.,When C(version) is C(v1) or C(v2c), this parameter is required.,The name C(public) is a reserved name on the BIG-IP. This module handles that name differently than others. Functionally, you should not see a difference however.

Returns:

  • (String, nil) —

    Name that identifies the SNMP community.,When C(version) is C(v1) or C(v2c), this parameter is required.,The name C(public) is a reserved name on the BIG-IP. This module handles that name differently than others. Functionally, you should not see a difference however.



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

attribute :name

#oid ⇒ Float?

Returns Specifies the object identifier (OID) for the record.,When C(version) is C(v3), this parameter is required.,When C(version) is either C(v1) or C(v2c), if this value is specified, then C(source) must not be set to C(all).

Returns:

  • (Float, nil) —

    Specifies the object identifier (OID) for the record.,When C(version) is C(v3), this parameter is required.,When C(version) is either C(v1) or C(v2c), if this value is specified, then C(source) must not be set to C(all).



34
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 34

attribute :oid

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



70
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 70

attribute :partition

#port ⇒ Object?

Returns Specifies the port for the trap destination.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.

Returns:

  • (Object, nil) —

    Specifies the port for the trap destination.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 31

attribute :port

#snmp_auth_password ⇒ String?

Returns Specifies the password for the user.,When creating a new SNMP C(v3) community, this parameter is required.,This value must be at least 8 characters long.

Returns:

  • (String, nil) —

    Specifies the password for the user.,When creating a new SNMP C(v3) community, this parameter is required.,This value must be at least 8 characters long.



54
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 54

attribute :snmp_auth_password

#snmp_auth_protocol ⇒ :md5, ...

Returns Specifies the authentication method for the user.,When C(md5), specifies that the system uses the MD5 algorithm to authenticate the user.,When C(sha), specifies that the secure hash algorithm (SHA) to authenticate the user.,When C(none), specifies that user does not require authentication.,When creating a new SNMP C(v3) community, if this parameter is not specified, the default of C(sha) will be used.

Returns:

  • (:md5, :sha, :none, nil) —

    Specifies the authentication method for the user.,When C(md5), specifies that the system uses the MD5 algorithm to authenticate the user.,When C(sha), specifies that the secure hash algorithm (SHA) to authenticate the user.,When C(none), specifies that user does not require authentication.,When creating a new SNMP C(v3) community, if this parameter is not specified, the default of C(sha) will be used.



50
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 50

attribute :snmp_auth_protocol

#snmp_privacy_password ⇒ String?

Returns Specifies the password for the user.,When creating a new SNMP C(v3) community, this parameter is required.,This value must be at least 8 characters long.

Returns:

  • (String, nil) —

    Specifies the password for the user.,When creating a new SNMP C(v3) community, this parameter is required.,This value must be at least 8 characters long.



62
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 62

attribute :snmp_privacy_password

#snmp_privacy_protocol ⇒ :aes, ...

Returns Specifies the encryption protocol.,When C(aes), specifies that the system encrypts the user information using AES (Advanced Encryption Standard).,When C(des), specifies that the system encrypts the user information using DES (Data Encryption Standard).,When C(none), specifies that the system does not encrypt the user information.,When creating a new SNMP C(v3) community, if this parameter is not specified, the default of C(aes) will be used.

Returns:

  • (:aes, :des, :none, nil) —

    Specifies the encryption protocol.,When C(aes), specifies that the system encrypts the user information using AES (Advanced Encryption Standard).,When C(des), specifies that the system encrypts the user information using DES (Data Encryption Standard).,When C(none), specifies that the system does not encrypt the user information.,When creating a new SNMP C(v3) community, if this parameter is not specified, the default of C(aes) will be used.



58
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 58

attribute :snmp_privacy_protocol

#snmp_username ⇒ String?

Returns Specifies the name of the user for whom you want to grant access to the SNMP v3 MIB.,This parameter is only relevant when C(version) is C(v3). If C(version) is something else, this parameter is ignored.,When creating a new SNMP C(v3) community, this parameter is required.,This parameter cannot be changed once it has been set.

Returns:

  • (String, nil) —

    Specifies the name of the user for whom you want to grant access to the SNMP v3 MIB.,This parameter is only relevant when C(version) is C(v3). If C(version) is something else, this parameter is ignored.,When creating a new SNMP C(v3) community, this parameter is required.,This parameter cannot be changed once it has been set.



46
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 46

attribute :snmp_username

#source ⇒ String?

Returns Specifies the source address for access to the MIB.,This parameter can accept a value of C(all).,If this parameter is not specified, the value C(all) is used.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.,If C(source) is set to C(all), then it is not possible to specify an C(oid). This will raise an error.,This parameter should be provided when C(state) is C(absent), so that the correct community is removed. To remove the C(public) SNMP community that comes with a BIG-IP, this parameter should be set to C(default).

Returns:

  • (String, nil) —

    Specifies the source address for access to the MIB.,This parameter can accept a value of C(all).,If this parameter is not specified, the value C(all) is used.,This parameter is only relevant when C(version) is C(v1), or C(v2c). If C(version) is something else, this parameter is ignored.,If C(source) is set to C(all), then it is not possible to specify an C(oid). This will raise an error.,This parameter should be provided when C(state) is C(absent), so that the correct community is removed. To remove the C(public) SNMP community that comes with a BIG-IP, this parameter should be set to C(default).



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 27

attribute :source

#state ⇒ :present, ...

Returns When C(present), ensures that the address list and entries exists.,When C(absent), ensures the address list is removed.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the address list and entries exists.,When C(absent), ensures the address list is removed.



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

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 resources.

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 resources.



66
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_snmp_community.rb', line 66

attribute :update_password

#version ⇒ :v1, ...

Returns Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies.

Returns:

  • (:v1, :v2c, :v3, nil) —

    Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies.



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

attribute :version