Class: Ansible::Ruby::Modules::Aos_external_router

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

Overview

Apstra AOS External Router module let you manage your External Router easily. You can create create and delete External Router by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It’s using the AOS REST API.

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

#asn ⇒ Integer?

Returns ASN id of the external_router.

Returns:

  • (Integer, nil) —

    ASN id of the external_router.



36
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_external_router.rb', line 36

attribute :asn

#content ⇒ String?

Returns Datastructure of the External Router to create. The format is defined by the I(content_format) parameter. It’s the same datastructure that is returned on success in I(value).

Returns:

  • (String, nil) —

    Datastructure of the External Router to create. The format is defined by the I(content_format) parameter. It’s the same datastructure that is returned on success in I(value).



24
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_external_router.rb', line 24

attribute :content

#id ⇒ String?

Returns AOS Id of the External Router to manage (can’t be used to create a new External Router), Only one of I(name), I(id) or I(content) can be set.

Returns:

  • (String, nil) —

    AOS Id of the External Router to manage (can’t be used to create a new External Router), Only one of I(name), I(id) or I(content) can be set.



20
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_external_router.rb', line 20

attribute :id

#loopback ⇒ String?

Returns IP address of the Loopback interface of the external_router.

Returns:

  • (String, nil) —

    IP address of the Loopback interface of the external_router.



32
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_external_router.rb', line 32

attribute :loopback

#name ⇒ String?

Returns Name of the External Router to manage. Only one of I(name), I(id) or I(content) can be set.

Returns:

  • (String, nil) —

    Name of the External Router to manage. Only one of I(name), I(id) or I(content) can be set.



16
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_external_router.rb', line 16

attribute :name

#session ⇒ String

Returns An existing AOS session as obtained by M(aos_login) module.

Returns:

  • (String) —

    An existing AOS session as obtained by M(aos_login) module.



12
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_external_router.rb', line 12

attribute :session

#state ⇒ :present, ...

Returns Indicate what is the expected state of the External Router (present or not).

Returns:

  • (:present, :absent, nil) —

    Indicate what is the expected state of the External Router (present or not).



28
 
# File 'lib/ansible/ruby/modules/generated/network/aos/aos_external_router.rb', line 28

attribute :state