Class: Ansible::Ruby::Modules::Tower_inventory_source

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

Overview

Create, update, or destroy Ansible Tower inventories source. 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 ⇒ String?

Returns Credential to use to retrieve the inventory from.

Returns:

  • (String, nil) —

    Credential to use to retrieve the inventory from.



28
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 28

attribute :credential

#description ⇒ String?

Returns The description to use for the inventory source.

Returns:

  • (String, nil) —

    The description to use for the inventory source.



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

attribute :description

#group_by ⇒ Object?

Returns Specify which groups to create automatically. Group names will be created similar to the options selected. If blank, all groups above are created. Refer to Ansible Tower documentation for more detail.

Returns:

  • (Object, nil) —

    Specify which groups to create automatically. Group names will be created similar to the options selected. If blank, all groups above are created. Refer to Ansible Tower documentation for more detail.



55
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 55

attribute :group_by

#instance_filters ⇒ Object?

Returns Provide a comma-separated list of filter expressions. Hosts are imported when all of the filters match. Refer to Ansible Tower documentation for more detail.

Returns:

  • (Object, nil) —

    Provide a comma-separated list of filter expressions. Hosts are imported when all of the filters match. Refer to Ansible Tower documentation for more detail.



52
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 52

attribute :instance_filters

#inventory ⇒ String

Returns The inventory the source is linked to.

Returns:

  • (String) —

    The inventory the source is linked to.



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

attribute :inventory

#name ⇒ String

Returns The name to use for the inventory source.

Returns:

  • (String) —

    The name to use for the inventory source.



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

attribute :name

#overwrite ⇒ Symbol?

Returns If set, any hosts and groups that were previously present on the external source but are now removed will be removed from the Tower inventory. Hosts and groups that were not managed by the inventory source will be promoted to the next manually created group or if there is no manually created group to promote them into, they will be left in the “all” default group for the inventory. When not checked, local child hosts and groups not found on the external source will remain untouched by the inventory update process.

Returns:

  • (Symbol, nil) —

    If set, any hosts and groups that were previously present on the external source but are now removed will be removed from the Tower inventory. Hosts and groups that were not managed by the inventory source will be promoted to the next manually created group or if there is no manually created group to promote them into, they will be left in the “all” default group for the inventory. When not checked, local child hosts and groups not found on the external source will remain untouched by the inventory update process.



61
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 61

attribute :overwrite

#overwrite_vars ⇒ Symbol?

Returns If set, all variables for child groups and hosts will be removed and replaced by those found on the external source. When not checked, a merge will be performed, combining local variables with those found on the external source.

Returns:

  • (Symbol, nil) —

    If set, all variables for child groups and hosts will be removed and replaced by those found on the external source. When not checked, a merge will be performed, combining local variables with those found on the external source.



65
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 65

attribute :overwrite_vars

#source ⇒ :file, ...

Returns Types of inventory source.

Returns:

  • (:file, :scm, :ec2, :gce, :azure, :azure_rm, :vmware, :satellite6, :cloudforms, :openstack, :rhv, :tower, :custom) —

    Types of inventory source.



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

attribute :source

#source_path ⇒ Object?

Returns Path to the file to use as a source in the selected project.

Returns:

  • (Object, nil) —

    Path to the file to use as a source in the selected project.



42
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 42

attribute :source_path

#source_project ⇒ Object?

Returns Use a project as a source for the inventory.

Returns:

  • (Object, nil) —

    Use a project as a source for the inventory.



39
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 39

attribute :source_project

#source_regions ⇒ Object?

Returns List of regions for your cloud provider. You can include multiple all regions. Only Hosts associated with the selected regions will be updated. Refer to Ansible Tower documentation for more detail.

Returns:

  • (Object, nil) —

    List of regions for your cloud provider. You can include multiple all regions. Only Hosts associated with the selected regions will be updated. Refer to Ansible Tower documentation for more detail.



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

attribute :source_regions

#source_script ⇒ Object?

Returns The source custom script to use to build the inventory. It needs to exist.

Returns:

  • (Object, nil) —

    The source custom script to use to build the inventory. It needs to exist.



58
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 58

attribute :source_script

#source_vars ⇒ String?

Returns The source_vars allow to Override variables found in the source config file. For example with Openstack, specifying *private: false* would change the output of the openstack.py script. It has to be YAML or JSON.

Returns:

  • (String, nil) —

    The source_vars allow to Override variables found in the source config file. For example with Openstack, specifying *private: false* would change the output of the openstack.py script. It has to be YAML or JSON.



32
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 32

attribute :source_vars

#state ⇒ :present, ...

Returns Desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Desired state of the resource.



76
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 76

attribute :state

#timeout ⇒ Object?

Returns Number in seconds after which the Tower API methods will time out.

Returns:

  • (Object, nil) —

    Number in seconds after which the Tower API methods will time out.



36
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 36

attribute :timeout

#tower_verify_ssl ⇒ Symbol?

Returns Tower option to avoid certificates check.

Returns:

  • (Symbol, nil) —

    Tower option to avoid certificates check.



80
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 80

attribute :tower_verify_ssl

#update_cache_timeout ⇒ Object?

Returns Time in seconds to consider an inventory sync to be current. During job runs and callbacks the task system will evaluate the timestamp of the latest sync. If it is older than Cache Timeout, it is not considered current, and a new inventory sync will be performed.

Returns:

  • (Object, nil) —

    Time in seconds to consider an inventory sync to be current. During job runs and callbacks the task system will evaluate the timestamp of the latest sync. If it is older than Cache Timeout, it is not considered current, and a new inventory sync will be performed.



73
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 73

attribute :update_cache_timeout

#update_on_launch ⇒ Symbol?

Returns Each time a job runs using this inventory, refresh the inventory from the selected source before executing job tasks.

Returns:

  • (Symbol, nil) —

    Each time a job runs using this inventory, refresh the inventory from the selected source before executing job tasks.



69
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 69

attribute :update_on_launch

#update_on_project_update ⇒ Symbol?

Returns That parameter will sync the inventory when the project is synced. It can only be used with a SCM source.

Returns:

  • (Symbol, nil) —

    That parameter will sync the inventory when the project is synced. It can only be used with a SCM source.



45
 
# File 'lib/ansible/ruby/modules/generated/web_infrastructure/ansible_tower/tower_inventory_source.rb', line 45

attribute :update_on_project_update