Class: Ansible::Ruby::Modules::Nxos_snmp_host

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

Overview

Manages SNMP host configuration parameters.

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

#community ⇒ String?

Returns Community string or v3 username.

Returns:

  • (String, nil) —

    Community string or v3 username.



24
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 24

attribute :community

#snmp_host ⇒ String

Returns IP address of hostname of target host.

Returns:

  • (String) —

    IP address of hostname of target host.



12
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 12

attribute :snmp_host

#snmp_type ⇒ :trap, ...

Returns type of message to send to host. If this is not specified, trap type is used.

Returns:

  • (:trap, :inform, nil) —

    type of message to send to host. If this is not specified, trap type is used.



32
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 32

attribute :snmp_type

#src_intf ⇒ Object?

Returns Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.

Returns:

  • (Object, nil) —

    Source interface. Must be fully qualified interface name. If state = absent, the interface is removed.



42
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 42

attribute :src_intf

#state ⇒ :present, ...

Returns Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.

Returns:

  • (:present, :absent, nil) —

    Manage the state of the resource. If state = present, the host is added to the configuration. If only vrf and/or vrf_filter and/or src_intf are given, they will be added to the existing host configuration. If state = absent, the host is removed if community parameter is given. It is possible to remove only vrf and/or src_int and/or vrf_filter by providing only those parameters and no community parameter.



45
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 45

attribute :state

#udp ⇒ Integer?

Returns UDP port number (0-65535).

Returns:

  • (Integer, nil) —

    UDP port number (0-65535).



28
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 28

attribute :udp

#v3 ⇒ :noauth, ...

Returns Use this when verion is v3. SNMPv3 Security level.

Returns:

  • (:noauth, :auth, :priv, nil) —

    Use this when verion is v3. SNMPv3 Security level.



20
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 20

attribute :v3

#version ⇒ :v1, ...

Returns SNMP version. If this is not specified, v1 is used.

Returns:

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

    SNMP version. If this is not specified, v1 is used.



16
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 16

attribute :version

#vrf ⇒ Object?

Returns VRF to use to source traffic to source. If state = absent, the vrf is removed.

Returns:

  • (Object, nil) —

    VRF to use to source traffic to source. If state = absent, the vrf is removed.



36
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 36

attribute :vrf

#vrf_filter ⇒ Object?

Returns Name of VRF to filter. If state = absent, the vrf is removed from the filter.

Returns:

  • (Object, nil) —

    Name of VRF to filter. If state = absent, the vrf is removed from the filter.



39
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_snmp_host.rb', line 39

attribute :vrf_filter