Class: Ansible::Ruby::Modules::Bigip_cli_alias

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

Overview

Allows for managing both private and shared aliases 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, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#command ⇒ String?

Returns The command to alias.

Returns:

  • (String, nil) —

    The command to alias.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_cli_alias.rb', line 20

attribute :command

#description ⇒ Object?

Returns Description of the alias.

Returns:

  • (Object, nil) —

    Description of the alias.



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_cli_alias.rb', line 24

attribute :description

#name ⇒ String

Returns Specifies the name of the alias.

Returns:

  • (String) —

    Specifies the name of the alias.



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

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.,This parameter is disregarded when the C(scope) is C(private).

Returns:

  • (String, nil) —

    Device partition to manage resources on.,This parameter is disregarded when the C(scope) is C(private).



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

attribute :partition

#scope ⇒ :private, ...

Returns The scope of the alias; whether it is shared on the system, or usable only for the user who created it.

Returns:

  • (:private, :shared, nil) —

    The scope of the alias; whether it is shared on the system, or usable only for the user who created it.



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

attribute :scope

#state ⇒ :present, ...

Returns When C(present), ensures that the resource exists.,When C(absent), ensures the resource is removed.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the resource exists.,When C(absent), ensures the resource is removed.



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

attribute :state