Class: Ansible::Ruby::Modules::Tower_group

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb

Overview

Create, update, or destroy Ansible Tower groups. See U(www.ansible.com/tower) for an overview.

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

#credential ⇒ Object?

Returns Credential to use for the group.

Returns:

  • (Object, nil) —

    Credential to use for the group.



27
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 27

attribute :credential

#description ⇒ String?

Returns The description to use for the group.

Returns:

  • (String, nil) —

    The description to use for the group.



16
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 16

attribute :description

#group_by ⇒ Object?

Returns Limit groups automatically created from inventory source.

Returns:

  • (Object, nil) —

    Limit groups automatically created from inventory source.



43
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 43

attribute :group_by

#instance_filters ⇒ Object?

Returns Comma-separated list of filter expressions for matching hosts.

Returns:

  • (Object, nil) —

    Comma-separated list of filter expressions for matching hosts.



40
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 40

attribute :instance_filters

#inventory ⇒ String

Returns Inventory the group should be made a member of.

Returns:

  • (String) —

    Inventory the group should be made a member of.



20
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 20

attribute :inventory

#name ⇒ String

Returns The name to use for the group.

Returns:

  • (String) —

    The name to use for the group.



12
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 12

attribute :name

#overwrite ⇒ :yes, ...

Returns Delete child groups and hosts not found in source.

Returns:

  • (:yes, :no, nil) —

    Delete child groups and hosts not found in source.



49
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 49

attribute :overwrite

#overwrite_vars ⇒ Object?

Returns Override vars in child groups and hosts with those from external source.

Returns:

  • (Object, nil) —

    Override vars in child groups and hosts with those from external source.



53
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 53

attribute :overwrite_vars

#source ⇒ :manual, ...

Returns The source to use for this group.

Returns:

  • (:manual, :file, :ec2, :rax, :vmware, :gce, :azure, :azure_rm, :openstack, :satellite6, :cloudforms, :custom, nil) —

    The source to use for this group.



30
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 30

attribute :source

#source_regions ⇒ Object?

Returns Regions for cloud provider.

Returns:

  • (Object, nil) —

    Regions for cloud provider.



34
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 34

attribute :source_regions

#source_script ⇒ Object?

Returns Inventory script to be used when group type is C(custom).

Returns:

  • (Object, nil) —

    Inventory script to be used when group type is C(custom).



46
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 46

attribute :source_script

#source_vars ⇒ Object?

Returns Override variables from source with variables from this field.

Returns:

  • (Object, nil) —

    Override variables from source with variables from this field.



37
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 37

attribute :source_vars

#state ⇒ :present, ...

Returns Desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Desired state of the resource.



60
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 60

attribute :state

#update_on_launch ⇒ :yes, ...

Returns Refresh inventory data from its source each time a job is run.

Returns:

  • (:yes, :no, nil) —

    Refresh inventory data from its source each time a job is run.



56
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 56

attribute :update_on_launch

#variables ⇒ Object?

Returns Variables to use for the group, use C(@) for a file.

Returns:

  • (Object, nil) —

    Variables to use for the group, use C(@) for a file.



24
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_group.rb', line 24

attribute :variables