Class: Ansible::Ruby::Modules::Nxos_igmp_interface

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

Overview

Manages IGMP interface configuration settings.

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

#group_timeout ⇒ Object?

Returns Sets the group membership timeout for IGMPv2. Values can range from 3 to 65,535 seconds or keyword ‘default’. The default is 260 seconds.

Returns:

  • (Object, nil) —

    Sets the group membership timeout for IGMPv2. Values can range from 3 to 65,535 seconds or keyword ‘default’. The default is 260 seconds.



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

attribute :group_timeout

#immediate_leave ⇒ Symbol?

Returns Enables the device to remove the group entry from the multicast routing table immediately upon receiving a leave message for the group. Use this command to minimize the leave latency of IGMPv2 group memberships on a given IGMP interface because the device does not send group-specific queries. The default is disabled.

Returns:

  • (Symbol, nil) —

    Enables the device to remove the group entry from the multicast routing table immediately upon receiving a leave message for the group. Use this command to minimize the leave latency of IGMPv2 group memberships on a given IGMP interface because the device does not send group-specific queries. The default is disabled.



52
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 52

attribute :immediate_leave

#interface ⇒ String

Returns The full interface name for IGMP configuration. e.g. I(Ethernet1/2).

Returns:

  • (String) —

    The full interface name for IGMP configuration. e.g. I(Ethernet1/2).



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

attribute :interface

#last_member_qrt ⇒ Object?

Returns Sets the query interval waited after sending membership reports before the software deletes the group state. Values can range from 1 to 25 seconds or keyword ‘default’. The default is 1 second.

Returns:

  • (Object, nil) —

    Sets the query interval waited after sending membership reports before the software deletes the group state. Values can range from 1 to 25 seconds or keyword ‘default’. The default is 1 second.



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

attribute :last_member_qrt

#last_member_query_count ⇒ Object?

Returns Sets the number of times that the software sends an IGMP query in response to a host leave message. Values can range from 1 to 5 or keyword ‘default’. The default is 2.

Returns:

  • (Object, nil) —

    Sets the number of times that the software sends an IGMP query in response to a host leave message. Values can range from 1 to 5 or keyword ‘default’. The default is 2.



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

attribute :last_member_query_count

#oif_prefix ⇒ Object?

Returns This argument is deprecated, please use oif_ps instead. Configure a prefix for static outgoing interface (OIF).

Returns:

  • (Object, nil) —

    This argument is deprecated, please use oif_ps instead. Configure a prefix for static outgoing interface (OIF).



59
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 59

attribute :oif_prefix

#oif_ps ⇒ Array<Hash>, ...

Returns Configure prefixes and sources for static outgoing interface (OIF). This is a list of dict where each dict has source and prefix defined or just prefix if source is not needed. The specified values will be configured on the device and if any previous prefix/sources exist, they will be removed. Keyword ‘default’ is also accpted which removes all existing prefix/sources.

Returns:

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

    Configure prefixes and sources for static outgoing interface (OIF). This is a list of dict where each dict has source and prefix defined or just prefix if source is not needed. The specified values will be configured on the device and if any previous prefix/sources exist, they will be removed. Keyword ‘default’ is also accpted which removes all existing prefix/sources.



65
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 65

attribute :oif_ps

#oif_routemap ⇒ Object?

Returns Configure a routemap for static outgoing interface (OIF) or keyword ‘default’.

Returns:

  • (Object, nil) —

    Configure a routemap for static outgoing interface (OIF) or keyword ‘default’.



56
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 56

attribute :oif_routemap

#oif_source ⇒ Object?

Returns This argument is deprecated, please use oif_ps instead. Configure a source for static outgoing interface (OIF).

Returns:

  • (Object, nil) —

    This argument is deprecated, please use oif_ps instead. Configure a source for static outgoing interface (OIF).



62
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 62

attribute :oif_source

#querier_timeout ⇒ Object?

Returns Sets the querier timeout that the software uses when deciding to take over as the querier. Values can range from 1 to 65535 seconds or keyword ‘default’. The default is 255 seconds.

Returns:

  • (Object, nil) —

    Sets the querier timeout that the software uses when deciding to take over as the querier. Values can range from 1 to 65535 seconds or keyword ‘default’. The default is 255 seconds.



30
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 30

attribute :querier_timeout

#query_interval ⇒ Object?

Returns Sets the frequency at which the software sends IGMP host query messages. Values can range from 1 to 18000 seconds or keyword ‘default’. The default is 125 seconds.

Returns:

  • (Object, nil) —

    Sets the frequency at which the software sends IGMP host query messages. Values can range from 1 to 18000 seconds or keyword ‘default’. The default is 125 seconds.



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

attribute :query_interval

#query_mrt ⇒ Object?

Returns Sets the response time advertised in IGMP queries. Values can range from 1 to 25 seconds or keyword ‘default’. The default is 10 seconds.

Returns:

  • (Object, nil) —

    Sets the response time advertised in IGMP queries. Values can range from 1 to 25 seconds or keyword ‘default’. The default is 10 seconds.



33
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 33

attribute :query_mrt

#report_llg ⇒ Symbol?

Returns Configures report-link-local-groups. Enables sending reports for groups in 224.0.0.0/24. Reports are always sent for nonlink local groups. By default, reports are not sent for link local groups.

Returns:

  • (Symbol, nil) —

    Configures report-link-local-groups. Enables sending reports for groups in 224.0.0.0/24. Reports are always sent for nonlink local groups. By default, reports are not sent for link local groups.



48
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 48

attribute :report_llg

#restart ⇒ Symbol?

Returns Restart IGMP. This is NOT idempotent as this is action only.

Returns:

  • (Symbol, nil) —

    Restart IGMP. This is NOT idempotent as this is action only.



69
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 69

attribute :restart

#robustness ⇒ Object?

Returns Sets the robustness variable. Values can range from 1 to 7 or keyword ‘default’. The default is 2.

Returns:

  • (Object, nil) —

    Sets the robustness variable. Values can range from 1 to 7 or keyword ‘default’. The default is 2.



27
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 27

attribute :robustness

#startup_query_count ⇒ Object?

Returns Query count used when the IGMP process starts up. The range is from 1 to 10 or keyword ‘default’. The default is 2.

Returns:

  • (Object, nil) —

    Query count used when the IGMP process starts up. The range is from 1 to 10 or keyword ‘default’. The default is 2.



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

attribute :startup_query_count

#startup_query_interval ⇒ Integer?

Returns Query interval used when the IGMP process starts up. The range is from 1 to 18000 or keyword ‘default’. The default is 31.

Returns:

  • (Integer, nil) —

    Query interval used when the IGMP process starts up. The range is from 1 to 18000 or keyword ‘default’. The default is 31.



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

attribute :startup_query_interval

#state ⇒ :present, ...

Returns Manages desired state of the resource.

Returns:

  • (:present, :absent, :default, nil) —

    Manages desired state of the resource.



73
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_igmp_interface.rb', line 73

attribute :state

#version ⇒ 2, ...

Returns IGMP version. It can be 2 or 3 or keyword ‘default’.

Returns:

  • (2, 3, :default, nil) —

    IGMP version. It can be 2 or 3 or keyword ‘default’.



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

attribute :version