Class: Ansible::Ruby::Modules::Snmp_facts

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Snmp_facts

Defined in:

lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb

Overview

Retrieve facts for a device using SNMP, the facts will be inserted to the ansible_facts key.

Instance Method Summary

• #authkey ⇒ String^?

  Authentication key, required if version is v3.

• #community ⇒ String^?

  The SNMP community string, required if version is v2/v2c.

• #host ⇒ String

  Set to target snmp server (normally {inventory_hostname}).

• #integrity ⇒ :md5, ...

  Hashing algorithm, required if version is v3.

• #level ⇒ :authPriv, ...

  Authentication level, required if version is v3.

• #privacy ⇒ :des, ...

  Encryption algorithm, required if level is authPriv.

• #privkey ⇒ String^?

  Encryption key, required if version is authPriv.

• #username ⇒ String^?

  Username for SNMPv3, required if version is v3.

• #version ⇒ :v2, ...

  SNMP Version to use, v2/v2c or v3.

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

#authkey ⇒ String^?

Returns Authentication key, required if version is v3.

Returns:

• (String, nil) —

  Authentication key, required if version is v3

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 36

attribute :authkey

#community ⇒ String^?

Returns The SNMP community string, required if version is v2/v2c.

Returns:

• (String, nil) —

  The SNMP community string, required if version is v2/v2c

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 20

attribute :community

#host ⇒ String

Returns Set to target snmp server (normally {inventory_hostname}).

Returns:

• (String) —

  Set to target snmp server (normally {inventory_hostname})

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 12

attribute :host

#integrity ⇒ :md5, ...

Returns Hashing algorithm, required if version is v3.

Returns:

• (:md5, :sha, nil) —

  Hashing algorithm, required if version is v3

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 32

attribute :integrity

#level ⇒ :authPriv, ...

Returns Authentication level, required if version is v3.

Returns:

• (:authPriv, :authNoPriv, nil) —

  Authentication level, required if version is v3

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 24

attribute :level

#privacy ⇒ :des, ...

Returns Encryption algorithm, required if level is authPriv.

Returns:

• (:des, :aes, nil) —

  Encryption algorithm, required if level is authPriv

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 40

attribute :privacy

#privkey ⇒ String^?

Returns Encryption key, required if version is authPriv.

Returns:

• (String, nil) —

  Encryption key, required if version is authPriv

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 44

attribute :privkey

#username ⇒ String^?

Returns Username for SNMPv3, required if version is v3.

Returns:

• (String, nil) —

  Username for SNMPv3, required if version is v3

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 28

attribute :username

#version ⇒ :v2, ...

Returns SNMP Version to use, v2/v2c or v3.

Returns:

• (:v2, :v2c, :v3) —

  SNMP Version to use, v2/v2c or v3

# File 'lib/ansible/ruby/modules/generated/net_tools/snmp_facts.rb', line 16

attribute :version