Class: Ansible::Ruby::Modules::Bigip_static_route

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

Overview

Manipulate static routes on a BIG-IP.

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

#description ⇒ Object?

Returns Descriptive text that identifies the route.

Returns:

  • (Object, nil) —

    Descriptive text that identifies the route.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 16

attribute :description

#destination ⇒ String?

Returns Specifies an IP address for the static entry in the routing table. When creating a new static route, this value is required.,This value cannot be changed once it is set.

Returns:

  • (String, nil) —

    Specifies an IP address for the static entry in the routing table. When creating a new static route, this value is required.,This value cannot be changed once it is set.



19
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 19

attribute :destination

#gateway_address ⇒ String?

Returns Specifies the router for the system to use when forwarding packets to the destination host or network. Also known as the next-hop router address. This can be either an IPv4 or IPv6 address. When it is an IPv6 address that starts with C(FE80:), the address will be treated as a link-local address. This requires that the C(vlan) parameter also be supplied.

Returns:

  • (String, nil) —

    Specifies the router for the system to use when forwarding packets to the destination host or network. Also known as the next-hop router address. This can be either an IPv4 or IPv6 address. When it is an IPv6 address that starts with C(FE80:), the address will be treated as a link-local address. This requires that the C(vlan) parameter also be supplied.



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 27

attribute :gateway_address

#mtu ⇒ Object?

Returns Specifies a specific maximum transmission unit (MTU).

Returns:

  • (Object, nil) —

    Specifies a specific maximum transmission unit (MTU).



41
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 41

attribute :mtu

#name ⇒ String

Returns Name of the static route.

Returns:

  • (String) —

    Name of the static route.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 12

attribute :name

#netmask ⇒ String?

Returns The netmask for the static route. When creating a new static route, this value is required.,This value can be in either IP or CIDR format.,This value cannot be changed once it is set.

Returns:

  • (String, nil) —

    The netmask for the static route. When creating a new static route, this value is required.,This value can be in either IP or CIDR format.,This value cannot be changed once it is set.



23
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 23

attribute :netmask

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



47
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 47

attribute :partition

#pool ⇒ Object?

Returns Specifies the pool through which the system forwards packets to the destination.

Returns:

  • (Object, nil) —

    Specifies the pool through which the system forwards packets to the destination.



34
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 34

attribute :pool

#reject ⇒ Symbol?

Returns Specifies that the system drops packets sent to the destination.

Returns:

  • (Symbol, nil) —

    Specifies that the system drops packets sent to the destination.



37
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 37

attribute :reject

#route_domain ⇒ Object?

Returns The route domain id of the system. When creating a new static route, if this value is not specified, a default value of C(0) will be used.,This value cannot be changed once it is set.

Returns:

  • (Object, nil) —

    The route domain id of the system. When creating a new static route, if this value is not specified, a default value of C(0) will be used.,This value cannot be changed once it is set.



44
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 44

attribute :route_domain

#state ⇒ :present, ...

Returns When C(present), ensures that the static route exists.,When C(absent), ensures that the static does not exist.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the static route exists.,When C(absent), ensures that the static does not exist.



51
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 51

attribute :state

#vlan ⇒ Object?

Returns Specifies the VLAN or Tunnel through which the system forwards packets to the destination. When C(gateway_address) is a link-local IPv6 address, this value is required.

Returns:

  • (Object, nil) —

    Specifies the VLAN or Tunnel through which the system forwards packets to the destination. When C(gateway_address) is a link-local IPv6 address, this value is required



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_static_route.rb', line 31

attribute :vlan