Class: Ansible::Ruby::Modules::Nxos_interface_ospf

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

Overview

Manages configuration of an OSPF interface instance.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#area ⇒ Integer

Returns Ospf area associated with this cisco_interface_ospf instance. Valid values are a string, formatted as an IP address (i.e. “0.0.0.0”) or as an integer.

Returns:

  • (Integer) —

    Ospf area associated with this cisco_interface_ospf instance. Valid values are a string, formatted as an IP address (i.e. “0.0.0.0”) or as an integer.



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

attribute :area

#cost ⇒ String?

Returns The cost associated with this cisco_interface_ospf instance.

Returns:

  • (String, nil) —

    The cost associated with this cisco_interface_ospf instance.



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

attribute :cost

#dead_interval ⇒ Object?

Returns Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer or the keyword ‘default’.

Returns:

  • (Object, nil) —

    Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer or the keyword ‘default’.



31
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface_ospf.rb', line 31

attribute :dead_interval

#hello_interval ⇒ Object?

Returns Time between sending successive hello packets. Valid values are an integer or the keyword ‘default’.

Returns:

  • (Object, nil) —

    Time between sending successive hello packets. Valid values are an integer or the keyword ‘default’.



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

attribute :hello_interval

#interface ⇒ String

Returns Name of this cisco_interface resource. Valid value is a string.

Returns:

  • (String) —

    Name of this cisco_interface resource. Valid value is a string.



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

attribute :interface

#message_digest ⇒ Symbol?

Returns Enables or disables the usage of message digest authentication.

Returns:

  • (Symbol, nil) —

    Enables or disables the usage of message digest authentication.



38
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface_ospf.rb', line 38

attribute :message_digest

#message_digest_algorithm_type ⇒ :md5, ...

Returns Algorithm used for authentication among neighboring routers within an area. Valid values are ‘md5’ and ‘default’.

Returns:

  • (:md5, :default, nil) —

    Algorithm used for authentication among neighboring routers within an area. Valid values are ‘md5’ and ‘default’.



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

attribute :message_digest_algorithm_type

#message_digest_encryption_type ⇒ :cisco_type_7, ...

Returns Specifies the scheme used for encrypting message_digest_password. Valid values are ‘3des’ or ‘cisco_type_7’ encryption or ‘default’.

Returns:

  • (:cisco_type_7, :"3des", :default, nil) —

    Specifies the scheme used for encrypting message_digest_password. Valid values are ‘3des’ or ‘cisco_type_7’ encryption or ‘default’.



49
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface_ospf.rb', line 49

attribute :message_digest_encryption_type

#message_digest_key_id ⇒ Object?

Returns Md5 authentication key-id associated with the ospf instance. If this is present, message_digest_encryption_type, message_digest_algorithm_type and message_digest_password are mandatory. Valid value is an integer and ‘default’.

Returns:

  • (Object, nil) —

    Md5 authentication key-id associated with the ospf instance. If this is present, message_digest_encryption_type, message_digest_algorithm_type and message_digest_password are mandatory. Valid value is an integer and ‘default’.



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

attribute :message_digest_key_id

#message_digest_password ⇒ Object?

Returns Specifies the message_digest password. Valid value is a string.

Returns:

  • (Object, nil) —

    Specifies the message_digest password. Valid value is a string.



53
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface_ospf.rb', line 53

attribute :message_digest_password

#ospf ⇒ Integer

Returns Name of the ospf instance.

Returns:

  • (Integer) —

    Name of the ospf instance.



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

attribute :ospf

#passive_interface ⇒ Symbol?

Returns Setting to true will prevent this interface from receiving HELLO packets.

Returns:

  • (Symbol, nil) —

    Setting to true will prevent this interface from receiving HELLO packets.



34
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface_ospf.rb', line 34

attribute :passive_interface

#state ⇒ :present, ...

Returns Determines whether the config should be present or not on the device.

Returns:

  • (:present, :absent, nil) —

    Determines whether the config should be present or not on the device.



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

attribute :state