ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-05 16:04:09 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Convert to reduced list of known types (#50010)

Browse source
This commit is contained in:
Dag Wieers 2018-12-18 22:25:30 +01:00 • committed by Jordan Borean
commit 05c6ff79f9
908 changed files with 4822 additions and 4821 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/ansible/modules/cloud/cloudstack/cs_account.py
View file

@ -163,37 +163,37 @@ RETURN = '''
id:
description: UUID of the account.
returned: success
type: string
type: str
sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name:
description: Name of the account.
returned: success
type: string
type: str
sample: linus@example.com
account_type:
description: Type of the account.
returned: success
type: string
type: str
sample: user
state:
description: State of the account.
returned: success
type: string
type: str
sample: enabled
network_domain:
description: Network domain of the account.
returned: success
type: string
type: str
sample: example.local
domain:
description: Domain the account is related.
returned: success
type: string
type: str
sample: ROOT
role:
description: The role name of the account
returned: success
type: string
type: str
sample: Domain Admin
'''

14
lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py
View file

@ -84,37 +84,37 @@ RETURN = '''
id:
description: UUID of the affinity group.
returned: success
type: string
type: str
sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name:
description: Name of affinity group.
returned: success
type: string
type: str
sample: app
description:
description: Description of affinity group.
returned: success
type: string
type: str
sample: application affinity group
affinity_type:
description: Type of affinity group.
returned: success
type: string
type: str
sample: host anti-affinity
project:
description: Name of project the affinity group is related to.
returned: success
type: string
type: str
sample: Production
domain:
description: Domain the affinity group is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the affinity group is related to.
returned: success
type: string
type: str
sample: example account
'''

22
lib/ansible/modules/cloud/cloudstack/cs_cluster.py
View file

@ -142,57 +142,57 @@ RETURN = '''
id:
description: UUID of the cluster.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the cluster.
returned: success
type: string
type: str
sample: cluster01
allocation_state:
description: State of the cluster.
returned: success
type: string
type: str
sample: Enabled
cluster_type:
description: Type of the cluster.
returned: success
type: string
type: str
sample: ExternalManaged
cpu_overcommit_ratio:
description: The CPU overcommit ratio of the cluster.
returned: success
type: string
type: str
sample: 1.0
memory_overcommit_ratio:
description: The memory overcommit ratio of the cluster.
returned: success
type: string
type: str
sample: 1.0
managed_state:
description: Whether this cluster is managed by CloudStack.
returned: success
type: string
type: str
sample: Managed
ovm3_vip:
description: Ovm3 VIP to use for pooling and/or clustering
returned: success
type: string
type: str
sample: 10.10.10.101
hypervisor:
description: Hypervisor of the cluster
returned: success
type: string
type: str
sample: VMware
zone:
description: Name of zone the cluster is in.
returned: success
type: string
type: str
sample: ch-gva-2
pod:
description: Name of pod the cluster is in.
returned: success
type: string
type: str
sample: pod01
'''

20
lib/ansible/modules/cloud/cloudstack/cs_configuration.py
View file

@ -95,52 +95,52 @@ RETURN = '''
category:
description: Category of the configuration.
returned: success
type: string
type: str
sample: Advanced
scope:
description: Scope (zone/cluster/storagepool/account) of the parameter that needs to be updated.
returned: success
type: string
type: str
sample: storagepool
description:
description: Description of the configuration.
returned: success
type: string
type: str
sample: Setup the host to do multipath
name:
description: Name of the configuration.
returned: success
type: string
type: str
sample: zone.vlan.capacity.notificationthreshold
value:
description: Value of the configuration.
returned: success
type: string
type: str
sample: "0.75"
account:
description: Account of the configuration.
returned: success
type: string
type: str
sample: admin
Domain:
description: Domain of account of the configuration.
returned: success
type: string
type: str
sample: ROOT
zone:
description: Zone of the configuration.
returned: success
type: string
type: str
sample: ch-gva-01
cluster:
description: Cluster of the configuration.
returned: success
type: string
type: str
sample: cluster01
storage:
description: Storage of the configuration.
returned: success
type: string
type: str
sample: storage01
'''

14
lib/ansible/modules/cloud/cloudstack/cs_disk_offering.py
View file

@ -128,7 +128,7 @@ RETURN = '''
id:
description: UUID of the disk offering
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
disk_size:
description: Size of the disk offering in GB
@ -168,17 +168,17 @@ iops_write_rate:
created:
description: Date the offering was created
returned: success
type: string
type: str
sample: 2017-11-19T10:48:59+0000
display_text:
description: Display text of the offering
returned: success
type: string
type: str
sample: Small 10GB
domain:
description: Domain the offering is into
returned: success
type: string
type: str
sample: ROOT
storage_tags:
description: List of storage tags
@ -193,17 +193,17 @@ customized:
name:
description: Name of the system offering
returned: success
type: string
type: str
sample: Micro
provisioning_type:
description: Provisioning type used to create volumes
returned: success
type: string
type: str
sample: thin
storage_type:
description: Storage type used to create volumes
returned: success
type: string
type: str
sample: shared
display_offering:
description: Whether to display the offering to the end user or not.

10
lib/ansible/modules/cloud/cloudstack/cs_domain.py
View file

@ -85,27 +85,27 @@ RETURN = '''
id:
description: UUID of the domain.
returned: success
type: string
type: str
sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
name:
description: Name of the domain.
returned: success
type: string
type: str
sample: customers
path:
description: Domain path.
returned: success
type: string
type: str
sample: /ROOT/customers
parent_domain:
description: Parent domain of the domain.
returned: success
type: string
type: str
sample: ROOT
network_domain:
description: Network domain of the domain.
returned: success
type: string
type: str
sample: example.local
'''

14
lib/ansible/modules/cloud/cloudstack/cs_facts.py
View file

@ -73,37 +73,37 @@ RETURN = '''
cloudstack_availability_zone:
description: zone the instance is deployed in.
returned: success
type: string
type: str
sample: ch-gva-2
cloudstack_instance_id:
description: UUID of the instance.
returned: success
type: string
type: str
sample: ab4e80b0-3e7e-4936-bdc5-e334ba5b0139
cloudstack_local_hostname:
description: local hostname of the instance.
returned: success
type: string
type: str
sample: VM-ab4e80b0-3e7e-4936-bdc5-e334ba5b0139
cloudstack_local_ipv4:
description: local IPv4 of the instance.
returned: success
type: string
type: str
sample: 185.19.28.35
cloudstack_public_hostname:
description: public IPv4 of the router. Same as C(cloudstack_public_ipv4).
returned: success
type: string
type: str
sample: VM-ab4e80b0-3e7e-4936-bdc5-e334ba5b0139
cloudstack_public_ipv4:
description: public IPv4 of the router.
returned: success
type: string
type: str
sample: 185.19.28.35
cloudstack_service_offering:
description: service offering of the instance.
returned: success
type: string
type: str
sample: Micro 512mb 1cpu
cloudstack_user_data:
description: data of the instance provided by users.

12
lib/ansible/modules/cloud/cloudstack/cs_firewall.py
View file

@ -141,22 +141,22 @@ RETURN = '''
id:
description: UUID of the rule.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
ip_address:
description: IP address of the rule if C(type=ingress)
returned: success
type: string
type: str
sample: 10.100.212.10
type:
description: Type of the rule.
returned: success
type: string
type: str
sample: ingress
cidr:
description: CIDR string of the rule.
returned: success
type: string
type: str
sample: 0.0.0.0/0
cidrs:
description: CIDR list of the rule.
@ -167,7 +167,7 @@ cidrs:
protocol:
description: Protocol of the rule.
returned: success
type: string
type: str
sample: tcp
start_port:
description: Start port of the rule.
@ -192,7 +192,7 @@ icmp_type:
network:
description: Name of the network if C(type=egress)
returned: success
type: string
type: str
sample: my_network
'''

54
lib/ansible/modules/cloud/cloudstack/cs_host.py
View file

@ -123,27 +123,27 @@ RETURN = '''
capabilities:
description: Capabilities of the host.
returned: success
type: string
type: str
sample: hvm
cluster:
description: Cluster of the host.
returned: success
type: string
type: str
sample: vcenter.example.com/zone/cluster01
cluster_type:
description: Type of the cluster of the host.
returned: success
type: string
type: str
sample: ExternalManaged
cpu_allocated:
description: Amount in percent of the host's CPU currently allocated.
returned: success
type: string
type: str
sample: 166.25%
cpu_number:
description: Number of CPUs of the host.
returned: success
type: string
type: str
sample: 24
cpu_sockets:
description: Number of CPU sockets of the host.
@ -158,22 +158,22 @@ cpu_speed:
cpu_used:
description: Amount of the host's CPU currently used.
returned: success
type: string
type: str
sample: 33.6%
cpu_with_overprovisioning:
description: Amount of the host's CPU after applying the cpu.overprovisioning.factor.
returned: success
type: string
type: str
sample: 959520.0
created:
description: Date when the host was created.
returned: success
type: string
type: str
sample: 2015-05-03T15:05:51+0200
disconnected:
description: Date when the host was disconnected.
returned: success
type: string
type: str
sample: 2015-05-03T15:05:51+0200
disk_size_allocated:
description: Host's currently allocated disk size.
@ -188,7 +188,7 @@ disk_size_total:
events:
description: Events available for the host
returned: success
type: string
type: str
sample: "Ping; HostDown; AgentConnected; AgentDisconnected; PingTimeout; ShutdownRequested; Remove; StartAgentRebalance; ManagementServerDown"
ha_host:
description: Whether the host is a HA host.
@ -203,22 +203,22 @@ has_enough_capacity:
host_tags:
description: Comma-separated list of tags for the host.
returned: success
type: string
type: str
sample: "perf"
hypervisor:
description: Host's hypervisor.
returned: success
type: string
type: str
sample: VMware
hypervisor_version:
description: Hypervisor version.
returned: success
type: string
type: str
sample: 5.1
ip_address:
description: IP address of the host
returned: success
type: string
type: str
sample: 10.10.10.1
is_local_storage_active:
description: Whether the local storage is available or not.
@ -228,7 +228,7 @@ is_local_storage_active:
last_pinged:
description: Date and time the host was last pinged.
returned: success
type: string
type: str
sample: "1970-01-17T17:27:32+0100"
management_server_id:
description: Management server ID of the host.
@ -253,7 +253,7 @@ memory_used:
name:
description: Name of the host.
returned: success
type: string
type: str
sample: esx32.example.com
network_kbs_read:
description: Incoming network traffic on the host.
@ -268,53 +268,53 @@ network_kbs_write:
os_category:
description: OS category name of the host.
returned: success
type: string
type: str
sample: ...
out_of_band_management:
description: Host out-of-band management information.
returned: success
type: string
type: str
sample: ...
pod:
description: Pod name of the host.
returned: success
type: string
type: str
sample: Pod01
removed:
description: Date and time the host was removed.
returned: success
type: string
type: str
sample: "1970-01-17T17:27:32+0100"
resource_state:
description: Resource state of the host.
returned: success
type: string
type: str
sample: Enabled
allocation_state::
description: Allocation state of the host.
returned: success
type: string
type: str
sample: enabled
state:
description: State of the host.
returned: success
type: string
type: str
sample: Up
suitable_for_migration:
description: Whether this host is suitable (has enough capacity and satisfies all conditions like hosttags, max guests VM limit, etc) to migrate a VM
to it or not.
returned: success
type: string
type: str
sample: true
host_type:
description: Type of the host.
returned: success
type: string
type: str
sample: Routing
host_version:
description: Version of the host.
returned: success
type: string
type: str
sample: 4.5.2
gpu_group:
description: GPU cards present in the host.
@ -324,7 +324,7 @@ gpu_group:
zone:
description: Zone of the host.
returned: success
type: string
type: str
sample: zone01
'''

46
lib/ansible/modules/cloud/cloudstack/cs_instance.py
View file

@ -251,104 +251,104 @@ RETURN = '''
id:
description: UUID of the instance.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the instance.
returned: success
type: string
type: str
sample: web-01
display_name:
description: Display name of the instance.
returned: success
type: string
type: str
sample: web-01
group:
description: Group name of the instance is related.
returned: success
type: string
type: str
sample: web
created:
description: Date of the instance was created.
returned: success
type: string
type: str
sample: 2014-12-01T14:57:57+0100
password_enabled:
description: True if password setting is enabled.
returned: success
type: boolean
type: bool
sample: true
password:
description: The password of the instance if exists.
returned: success
type: string
type: str
sample: Ge2oe7Do
ssh_key:
description: Name of SSH key deployed to instance.
returned: success
type: string
type: str
sample: key@work
domain:
description: Domain the instance is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the instance is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the instance is related to.
returned: success
type: string
type: str
sample: Production
default_ip:
description: Default IP address of the instance.
returned: success
type: string
type: str
sample: 10.23.37.42
default_ip6:
description: Default IPv6 address of the instance.
returned: success
type: string
type: str
sample: 2a04:c43:c00:a07:4b4:beff:fe00:74
version_added: '2.6'
public_ip:
description: Public IP address with instance via static NAT rule.
returned: success
type: string
type: str
sample: 1.2.3.4
iso:
description: Name of ISO the instance was deployed with.
returned: success
type: string
type: str
sample: Debian-8-64bit
template:
description: Name of template the instance was deployed with.
returned: success
type: string
type: str
sample: Linux Debian 9 64-bit
template_display_text:
description: Display text of template the instance was deployed with.
returned: success
type: string
type: str
sample: Linux Debian 9 64-bit 200G Disk (2017-10-08-622866)
version_added: 2.6
service_offering:
description: Name of the service offering the instance has.
returned: success
type: string
type: str
sample: 2cpu_2gb
zone:
description: Name of zone the instance is in.
returned: success
type: string
type: str
sample: ch-gva-2
state:
description: State of the instance.
returned: success
type: string
type: str
sample: Running
security_groups:
description: Security groups the instance is in.
@ -368,18 +368,18 @@ tags:
hypervisor:
description: Hypervisor related to this instance.
returned: success
type: string
type: str
sample: KVM
host:
description: Hostname of hypervisor an instance is running on.
returned: success and instance is running
type: string
type: str
sample: host-01.example.com
version_added: 2.6
instance_name:
description: Internal name of the instance (ROOT admin only).
returned: success
type: string
type: str
sample: i-44-3992-VM
'''

42
lib/ansible/modules/cloud/cloudstack/cs_instance_facts.py
View file

@ -57,92 +57,92 @@ RETURN = '''
id:
description: UUID of the instance.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the instance.
returned: success
type: string
type: str
sample: web-01
display_name:
description: Display name of the instance.
returned: success
type: string
type: str
sample: web-01
group:
description: Group name of the instance is related.
returned: success
type: string
type: str
sample: web
created:
description: Date of the instance was created.
returned: success
type: string
type: str
sample: 2014-12-01T14:57:57+0100
password_enabled:
description: True if password setting is enabled.
returned: success
type: boolean
type: bool
sample: true
password:
description: The password of the instance if exists.
returned: success
type: string
type: str
sample: Ge2oe7Do
ssh_key:
description: Name of SSH key deployed to instance.
returned: success
type: string
type: str
sample: key@work
domain:
description: Domain the instance is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the instance is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the instance is related to.
returned: success
type: string
type: str
sample: Production
default_ip:
description: Default IP address of the instance.
returned: success
type: string
type: str
sample: 10.23.37.42
public_ip:
description: Public IP address with instance via static NAT rule.
returned: success
type: string
type: str
sample: 1.2.3.4
iso:
description: Name of ISO the instance was deployed with.
returned: success
type: string
type: str
sample: Debian-8-64bit
template:
description: Name of template the instance was deployed with.
returned: success
type: string
type: str
sample: Debian-8-64bit
service_offering:
description: Name of the service offering the instance has.
returned: success
type: string
type: str
sample: 2cpu_2gb
zone:
description: Name of zone the instance is in.
returned: success
type: string
type: str
sample: ch-gva-2
state:
description: State of the instance.
returned: success
type: string
type: str
sample: Running
security_groups:
description: Security groups the instance is in.
@ -162,18 +162,18 @@ tags:
hypervisor:
description: Hypervisor related to this instance.
returned: success
type: string
type: str
sample: KVM
host:
description: Host the instance is running on.
returned: success and instance is running
type: string
type: str
sample: host01.example.com
version_added: '2.6'
instance_name:
description: Internal name of the instance (ROOT admin only).
returned: success
type: string
type: str
sample: i-44-3992-VM
volumes:
description: List of dictionaries of the volumes attached to the instance.

18
lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py
View file

@ -103,47 +103,47 @@ RETURN = '''
id:
description: UUID of the nic.
returned: success
type: string
type: str
sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
vm:
description: Name of the VM.
returned: success
type: string
type: str
sample: web-01
ip_address:
description: Primary IP of the NIC.
returned: success
type: string
type: str
sample: 10.10.10.10
netmask:
description: Netmask of the NIC.
returned: success
type: string
type: str
sample: 255.255.255.0
mac_address:
description: MAC address of the NIC.
returned: success
type: string
type: str
sample: 02:00:33:31:00:e4
network:
description: Name of the network if not default.
returned: success
type: string
type: str
sample: sync network
domain:
description: Domain the VM is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the VM is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the VM is related to.
returned: success
type: string
type: str
sample: Production
'''

20
lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py
View file

@ -101,52 +101,52 @@ RETURN = '''
id:
description: UUID of the NIC.
returned: success
type: string
type: str
sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
vm:
description: Name of the VM.
returned: success
type: string
type: str
sample: web-01
ip_address:
description: Primary IP of the NIC.
returned: success
type: string
type: str
sample: 10.10.10.10
netmask:
description: Netmask of the NIC.
returned: success
type: string
type: str
sample: 255.255.255.0
mac_address:
description: MAC address of the NIC.
returned: success
type: string
type: str
sample: 02:00:33:31:00:e4
vm_guest_ip:
description: Secondary IP of the NIC.
returned: success
type: string
type: str
sample: 10.10.10.10
network:
description: Name of the network if not default.
returned: success
type: string
type: str
sample: sync network
domain:
description: Domain the VM is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the VM is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the VM is related to.
returned: success
type: string
type: str
sample: Production
'''

4
lib/ansible/modules/cloud/cloudstack/cs_instance_password_reset.py
View file

@ -90,12 +90,12 @@ RETURN = '''
id:
description: ID of the virtual machine.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
password:
description: The new default password.
returned: success
type: string
type: str
sample: ahQu5nuNge3keesh
'''

12
lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py
View file

@ -71,32 +71,32 @@ RETURN = '''
id:
description: UUID of the instance group.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the instance group.
returned: success
type: string
type: str
sample: webservers
created:
description: Date when the instance group was created.
returned: success
type: string
type: str
sample: 2015-05-03T15:05:51+0200
domain:
description: Domain the instance group is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the instance group is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Project the instance group is related to.
returned: success
type: string
type: str
sample: example project
'''

12
lib/ansible/modules/cloud/cloudstack/cs_ip_address.py
View file

@ -107,32 +107,32 @@ RETURN = '''
id:
description: UUID of the Public IP address.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
ip_address:
description: Public IP address.
returned: success
type: string
type: str
sample: 1.2.3.4
zone:
description: Name of zone the IP address is related to.
returned: success
type: string
type: str
sample: ch-gva-2
project:
description: Name of project the IP address is related to.
returned: success
type: string
type: str
sample: Production
account:
description: Account the IP address is related to.
returned: success
type: string
type: str
sample: example account
domain:
description: Domain the IP address is related to.
returned: success
type: string
type: str
sample: example domain
tags:
description: List of resource tags associated with the IP address.

34
lib/ansible/modules/cloud/cloudstack/cs_iso.py
View file

@ -151,93 +151,93 @@ RETURN = '''
id:
description: UUID of the ISO.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: Name of the ISO.
returned: success
type: string
type: str
sample: Debian 7 64-bit
display_text:
description: Text to be displayed of the ISO.
returned: success
type: string
type: str
sample: Debian 7.7 64-bit minimal 2015-03-19
zone:
description: Name of zone the ISO is registered in.
returned: success
type: string
type: str
sample: zuerich
status:
description: Status of the ISO.
returned: success
type: string
type: str
sample: Successfully Installed
is_ready:
description: True if the ISO is ready to be deployed from.
returned: success
type: boolean
type: bool
sample: true
is_public:
description: True if the ISO is public.
returned: success
type: boolean
type: bool
sample: true
version_added: "2.4"
bootable:
description: True if the ISO is bootable.
returned: success
type: boolean
type: bool
sample: true
version_added: "2.4"
is_featured:
description: True if the ISO is featured.
returned: success
type: boolean
type: bool
sample: true
version_added: "2.4"
format:
description: Format of the ISO.
returned: success
type: string
type: str
sample: ISO
version_added: "2.4"
os_type:
description: Typo of the OS.
returned: success
type: string
type: str
sample: CentOS 6.5 (64-bit)
version_added: "2.4"
checksum:
description: MD5 checksum of the ISO.
returned: success
type: string
type: str
sample: 0b31bccccb048d20b551f70830bb7ad0
created:
description: Date of registering.
returned: success
type: string
type: str
sample: 2015-03-29T14:57:06+0200
cross_zones:
description: true if the ISO is managed across all zones, false otherwise.
returned: success
type: boolean
type: bool
sample: false
version_added: "2.4"
domain:
description: Domain the ISO is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the ISO is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Project the ISO is related to.
returned: success
type: string
type: str
sample: example project
tags:
description: List of resource tags associated with the ISO.

28
lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py
View file

@ -129,67 +129,67 @@ RETURN = '''
id:
description: UUID of the rule.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
zone:
description: Name of zone the rule is related to.
returned: success
type: string
type: str
sample: ch-gva-2
project:
description: Name of project the rule is related to.
returned: success
type: string
type: str
sample: Production
account:
description: Account the rule is related to.
returned: success
type: string
type: str
sample: example account
domain:
description: Domain the rule is related to.
returned: success
type: string
type: str
sample: example domain
algorithm:
description: Load balancer algorithm used.
returned: success
type: string
type: str
sample: "source"
cidr:
description: CIDR to forward traffic from.
returned: success
type: string
type: str
sample: ""
name:
description: Name of the rule.
returned: success
type: string
type: str
sample: "http-lb"
description:
description: Description of the rule.
returned: success
type: string
type: str
sample: "http load balancer rule"
protocol:
description: Protocol of the rule.
returned: success
type: string
type: str
sample: "tcp"
public_port:
description: Public port.
returned: success
type: string
type: str
sample: 80
private_port:
description: Private IP address.
returned: success
type: string
type: str
sample: 80
public_ip:
description: Public IP address.
returned: success
type: string
type: str
sample: "1.2.3.4"
tags:
description: List of resource tags associated with the rule.
@ -199,7 +199,7 @@ tags:
state:
description: State of the rule.
returned: success
type: string
type: str
sample: "Add"
'''

28
lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py
View file

@ -105,67 +105,67 @@ RETURN = '''
id:
description: UUID of the rule.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
zone:
description: Name of zone the rule is related to.
returned: success
type: string
type: str
sample: ch-gva-2
project:
description: Name of project the rule is related to.
returned: success
type: string
type: str
sample: Production
account:
description: Account the rule is related to.
returned: success
type: string
type: str
sample: example account
domain:
description: Domain the rule is related to.
returned: success
type: string
type: str
sample: example domain
algorithm:
description: Load balancer algorithm used.
returned: success
type: string
type: str
sample: "source"
cidr:
description: CIDR to forward traffic from.
returned: success
type: string
type: str
sample: ""
name:
description: Name of the rule.
returned: success
type: string
type: str
sample: "http-lb"
description:
description: Description of the rule.
returned: success
type: string
type: str
sample: "http load balancer rule"
protocol:
description: Protocol of the rule.
returned: success
type: string
type: str
sample: "tcp"
public_port:
description: Public port.
returned: success
type: string
type: str
sample: 80
private_port:
description: Private IP address.
returned: success
type: string
type: str
sample: 80
public_ip:
description: Public IP address.
returned: success
type: string
type: str
sample: "1.2.3.4"
vms:
description: Rule members.
@ -180,7 +180,7 @@ tags:
state:
description: State of the rule.
returned: success
type: string
type: str
sample: "Add"
'''

52
lib/ansible/modules/cloud/cloudstack/cs_network.py
View file

@ -175,72 +175,72 @@ RETURN = '''
id:
description: UUID of the network.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the network.
returned: success
type: string
type: str
sample: web project
display_text:
description: Display text of the network.
returned: success
type: string
type: str
sample: web project
dns1:
description: IP address of the 1st nameserver.
returned: success
type: string
type: str
sample: 1.2.3.4
dns2:
description: IP address of the 2nd nameserver.
returned: success
type: string
type: str
sample: 1.2.3.4
cidr:
description: IPv4 network CIDR.
returned: success
type: string
type: str
sample: 10.101.64.0/24
gateway:
description: IPv4 gateway.
returned: success
type: string
type: str
sample: 10.101.64.1
netmask:
description: IPv4 netmask.
returned: success
type: string
type: str
sample: 255.255.255.0
cidr_ipv6:
description: IPv6 network CIDR.
returned: success
type: string
type: str
sample: 2001:db8::/64
gateway_ipv6:
description: IPv6 gateway.
returned: success
type: string
type: str
sample: 2001:db8::1
zone:
description: Name of zone.
returned: success
type: string
type: str
sample: ch-gva-2
domain:
description: Domain the network is related to.
returned: success
type: string
type: str
sample: ROOT
account:
description: Account the network is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project.
returned: success
type: string
type: str
sample: Production
tags:
description: List of resource tags associated with the network.
@ -250,59 +250,59 @@ tags:
acl_type:
description: Access type of the VPC network tier (Domain, Account).
returned: success
type: string
type: str
sample: Account
acl:
description: Name of the access control list for the VPC network tier.
returned: success
type: string
type: str
sample: My ACL
version_added: "2.5"
acl_id:
description: ID of the access control list for the VPC network tier.
returned: success
type: string
type: str
sample: dfafcd55-0510-4b8c-b6c5-b8cedb4cfd88
version_added: "2.5"
broadcast_domain_type:
description: Broadcast domain type of the network.
returned: success
type: string
type: str
sample: Vlan
type:
description: Type of the network.
returned: success
type: string
type: str
sample: Isolated
traffic_type:
description: Traffic type of the network.
returned: success
type: string
type: str
sample: Guest
state:
description: State of the network (Allocated, Implemented, Setup).
returned: success
type: string
type: str
sample: Allocated
is_persistent:
description: Whether the network is persistent or not.
returned: success
type: boolean
type: bool
sample: false
network_domain:
description: The network domain
returned: success
type: string
type: str
sample: example.local
network_offering:
description: The network offering name.
returned: success
type: string
type: str
sample: DefaultIsolatedNetworkOfferingWithSourceNatService
network_offering_display_text:
description: The network offering display text.
returned: success
type: string
type: str
sample: Offering for Isolated Vpc networks with Source Nat service enabled
version_added: "2.5"
network_offering_conserve_mode:
@ -314,7 +314,7 @@ network_offering_conserve_mode:
network_offering_availability:
description: The availability of the network offering the network is created from
returned: success
type: string
type: str
sample: Optional
version_added: "2.5"
is_system:

8
lib/ansible/modules/cloud/cloudstack/cs_network_acl.py
View file

@ -90,22 +90,22 @@ RETURN = '''
name:
description: Name of the network ACL.
returned: success
type: string
type: str
sample: customer acl
description:
description: Description of the network ACL.
returned: success
type: string
type: str
sample: Example description of a network ACL
vpc:
description: VPC of the network ACL.
returned: success
type: string
type: str
sample: customer vpc
zone:
description: Zone the VPC is related to.
returned: success
type: string
type: str
sample: ch-gva-2
'''

22
lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py
View file

@ -154,12 +154,12 @@ RETURN = '''
network_acl:
description: Name of the network ACL.
returned: success
type: string
type: str
sample: customer acl
cidr:
description: CIDR of the network ACL rule.
returned: success
type: string
type: str
sample: 0.0.0.0/0
rule_position:
description: Position of the network ACL rule.
@ -169,17 +169,17 @@ rule_position:
action_policy:
description: Action policy of the network ACL rule.
returned: success
type: string
type: str
sample: deny
traffic_type:
description: Traffic type of the network ACL rule.
returned: success
type: string
type: str
sample: ingress
protocol:
description: Protocol of the network ACL rule.
returned: success
type: string
type: str
sample: tcp
protocol_number:
description: Protocol number in case protocol is by number.
@ -209,12 +209,12 @@ icmp_type:
state:
description: State of the network ACL rule.
returned: success
type: string
type: str
sample: Active
vpc:
description: VPC of the network ACL.
returned: success
type: string
type: str
sample: customer vpc
tags:
description: List of resource tags associated with the network ACL rule.
@ -224,22 +224,22 @@ tags:
domain:
description: Domain the network ACL rule is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the network ACL rule is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the network ACL rule is related to.
returned: success
type: string
type: str
sample: Production
zone:
description: Zone the VPC is related to.
returned: success
type: string
type: str
sample: ch-gva-2
'''

18
lib/ansible/modules/cloud/cloudstack/cs_network_offering.py
View file

@ -127,37 +127,37 @@ RETURN = '''
id:
description: UUID of the network offering.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: The name of the network offering.
returned: success
type: string
type: str
sample: MyCustomNetworkOffering
display_text:
description: The display text of the network offering.
returned: success
type: string
type: str
sample: My network offering
state:
description: The state of the network offering.
returned: success
type: string
type: str
sample: Enabled
guest_ip_type:
description: Guest type of the network offering.
returned: success
type: string
type: str
sample: Isolated
availability:
description: The availability of network offering.
returned: success
type: string
type: str
sample: Optional
service_offering_id:
description: The service offering ID.
returned: success
type: string
type: str
sample: c5f7a5fc-43f8-11e5-a151-feff819cdc9f
max_connections:
description: The maximum number of concurrents connections to be handled by LB.
@ -172,12 +172,12 @@ network_rate:
traffic_type:
description: The traffic type.
returned: success
type: string
type: str
sample: Guest
egress_default_policy:
description: Default egress policy.
returned: success
type: string
type: str
sample: allow
is_persistent:
description: Whether persistent networks are supported or not.

16
lib/ansible/modules/cloud/cloudstack/cs_pod.py
View file

@ -90,42 +90,42 @@ RETURN = '''
id:
description: UUID of the pod.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the pod.
returned: success
type: string
type: str
sample: pod01
start_ip:
description: Starting IP of the pod.
returned: success
type: string
type: str
sample: 10.100.1.101
end_ip:
description: Ending IP of the pod.
returned: success
type: string
type: str
sample: 10.100.1.254
netmask:
description: Netmask of the pod.
returned: success
type: string
type: str
sample: 255.255.255.0
gateway:
description: Gateway of the pod.
returned: success
type: string
type: str
sample: 10.100.1.1
allocation_state:
description: State of the pod.
returned: success
type: string
type: str
sample: Enabled
zone:
description: Name of zone the pod is in.
returned: success
type: string
type: str
sample: ch-gva-2
'''

16
lib/ansible/modules/cloud/cloudstack/cs_portforward.py
View file

@ -142,17 +142,17 @@ RETURN = '''
id:
description: UUID of the public IP address.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
ip_address:
description: Public IP address.
returned: success
type: string
type: str
sample: 1.2.3.4
protocol:
description: Protocol.
returned: success
type: string
type: str
sample: tcp
private_port:
description: Start port on the virtual machine's IP address.
@ -181,27 +181,27 @@ tags:
vm_name:
description: Name of the virtual machine.
returned: success
type: string
type: str
sample: web-01
vm_display_name:
description: Display name of the virtual machine.
returned: success
type: string
type: str
sample: web-01
vm_guest_ip:
description: IP of the virtual machine.
returned: success
type: string
type: str
sample: 10.101.65.152
vpc:
description: Name of the VPC.
returned: success
type: string
type: str
sample: my_vpc
network:
description: Name of the network.
returned: success
type: string
type: str
sample: dmz
'''

12
lib/ansible/modules/cloud/cloudstack/cs_project.py
View file

@ -103,32 +103,32 @@ RETURN = '''
id:
description: UUID of the project.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the project.
returned: success
type: string
type: str
sample: web project
display_text:
description: Display text of the project.
returned: success
type: string
type: str
sample: web project
state:
description: State of the project.
returned: success
type: string
type: str
sample: Active
domain:
description: Domain the project is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the project is related to.
returned: success
type: string
type: str
sample: example account
tags:
description: List of resource tags associated with the project.

4
lib/ansible/modules/cloud/cloudstack/cs_region.py
View file

@ -78,12 +78,12 @@ id:
name:
description: Name of the region.
returned: success
type: string
type: str
sample: local
endpoint:
description: Endpoint of the region.
returned: success
type: string
type: str
sample: http://cloud.example.com
gslb_service_enabled:
description: Whether the GSLB service is enabled or not.

8
lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py
View file

@ -75,7 +75,7 @@ RETURN = '''
recource_type:
description: Type of the resource
returned: success
type: string
type: str
sample: instance
limit:
description: Maximum number of the resource.
@ -85,17 +85,17 @@ limit:
domain:
description: Domain the resource is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the resource is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Project the resource is related to.
returned: success
type: string
type: str
sample: example project
'''

8
lib/ansible/modules/cloud/cloudstack/cs_role.py
View file

@ -82,22 +82,22 @@ RETURN = '''
id:
description: UUID of the role.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the role.
returned: success
type: string
type: str
sample: myrole
description:
description: Description of the role.
returned: success
type: string
type: str
sample: "This is my role description"
role_type:
description: Type of the role.
returned: success
type: string
type: str
sample: User
'''

10
lib/ansible/modules/cloud/cloudstack/cs_role_permission.py
View file

@ -81,27 +81,27 @@ RETURN = '''
id:
description: The ID of the role permission.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: The API name of the permission.
returned: success
type: string
type: str
sample: createVPC
permission:
description: The permission type of the api name.
returned: success
type: string
type: str
sample: allow
role_id:
description: The ID of the role to which the role permission belongs.
returned: success
type: string
type: str
sample: c6f7a5fc-43f8-11e5-a151-feff819cdc7f
description:
description: The description of the role permission
returned: success
type: string
type: str
sample: Deny createVPC for users
'''

22
lib/ansible/modules/cloud/cloudstack/cs_router.py
View file

@ -107,22 +107,22 @@ RETURN = '''
id:
description: UUID of the router.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the router.
returned: success
type: string
type: str
sample: r-40-VM
created:
description: Date of the router was created.
returned: success
type: string
type: str
sample: 2014-12-01T14:57:57+0100
template_version:
description: Version of the system VM template.
returned: success
type: string
type: str
sample: 4.5.1
requires_upgrade:
description: Whether the router needs to be upgraded to the new template.
@ -132,37 +132,37 @@ requires_upgrade:
redundant_state:
description: Redundant state of the router.
returned: success
type: string
type: str
sample: UNKNOWN
role:
description: Role of the router.
returned: success
type: string
type: str
sample: VIRTUAL_ROUTER
zone:
description: Name of zone the router is in.
returned: success
type: string
type: str
sample: ch-gva-2
service_offering:
description: Name of the service offering the router has.
returned: success
type: string
type: str
sample: System Offering For Software Router
state:
description: State of the router.
returned: success
type: string
type: str
sample: Active
domain:
description: Domain the router is related to.
returned: success
type: string
type: str
sample: ROOT
account:
description: Account the router is related to.
returned: success
type: string
type: str
sample: admin
'''

12
lib/ansible/modules/cloud/cloudstack/cs_securitygroup.py
View file

@ -65,17 +65,17 @@ RETURN = '''
id:
description: UUID of the security group.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: Name of security group.
returned: success
type: string
type: str
sample: app
description:
description: Description of security group.
returned: success
type: string
type: str
sample: application security group
tags:
description: List of resource tags associated with the security group.
@ -85,17 +85,17 @@ tags:
project:
description: Name of project the security group is related to.
returned: success
type: string
type: str
sample: Production
domain:
description: Domain the security group is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the security group is related to.
returned: success
type: string
type: str
sample: example account
'''

12
lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py
View file

@ -121,32 +121,32 @@ RETURN = '''
id:
description: UUID of the of the rule.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
security_group:
description: security group of the rule.
returned: success
type: string
type: str
sample: default
type:
description: type of the rule.
returned: success
type: string
type: str
sample: ingress
cidr:
description: CIDR of the rule.
returned: success and cidr is defined
type: string
type: str
sample: 0.0.0.0/0
user_security_group:
description: user security group of the rule.
returned: success and user_security_group is defined
type: string
type: str
sample: default
protocol:
description: protocol of the rule.
returned: success
type: string
type: str
sample: tcp
start_port:
description: start port of the rule.

16
lib/ansible/modules/cloud/cloudstack/cs_service_offering.py
View file

@ -210,7 +210,7 @@ RETURN = '''
id:
description: UUID of the service offering
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
cpu_number:
description: Number of CPUs in the service offering
@ -255,17 +255,17 @@ disk_iops_write_rate:
created:
description: Date the offering was created
returned: success
type: string
type: str
sample: 2017-11-19T10:48:59+0000
display_text:
description: Display text of the offering
returned: success
type: string
type: str
sample: Micro 512mb 1cpu
domain:
description: Domain the offering is into
returned: success
type: string
type: str
sample: ROOT
host_tags:
description: List of host tags
@ -305,7 +305,7 @@ memory:
name:
description: Name of the system offering
returned: success
type: string
type: str
sample: Micro
offer_ha:
description: Whether HA support is enabled in the offering or not
@ -315,17 +315,17 @@ offer_ha:
provisioning_type:
description: Provisioning type used to create volumes
returned: success
type: string
type: str
sample: thin
storage_type:
description: Storage type used to create volumes
returned: success
type: string
type: str
sample: shared
system_vm_type:
description: System VM type of this offering
returned: success
type: string
type: str
sample: consoleproxy
service_offering_details:
description: Additioanl service offering details

18
lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py
View file

@ -135,17 +135,17 @@ RETURN = '''
id:
description: UUID of the snapshot policy.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
interval_type:
description: interval type of the snapshot policy.
returned: success
type: string
type: str
sample: daily
schedule:
description: schedule of the snapshot policy.
returned: success
type: string
type: str
sample:
max_snaps:
description: maximum number of snapshots retained.
@ -155,32 +155,32 @@ max_snaps:
time_zone:
description: the time zone of the snapshot policy.
returned: success
type: string
type: str
sample: Etc/UTC
volume:
description: the volume of the snapshot policy.
returned: success
type: string
type: str
sample: Etc/UTC
zone:
description: Name of zone the volume is related to.
returned: success
type: string
type: str
sample: ch-gva-2
project:
description: Name of project the volume is related to.
returned: success
type: string
type: str
sample: Production
account:
description: Account the volume is related to.
returned: success
type: string
type: str
sample: example account
domain:
description: Domain the volume is related to.
returned: success
type: string
type: str
sample: example domain
'''

8
lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py
View file

@ -85,22 +85,22 @@ RETURN = '''
id:
description: UUID of the SSH public key.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: Name of the SSH public key.
returned: success
type: string
type: str
sample: linus@example.com
fingerprint:
description: Fingerprint of the SSH public key.
returned: success
type: string
type: str
sample: "86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28"
private_key:
description: Private key of generated SSH keypair.
returned: changed
type: string
type: str
sample: "-----BEGIN RSA PRIVATE KEY-----\nMII...8tO\n-----END RSA PRIVATE KEY-----\n"
'''

18
lib/ansible/modules/cloud/cloudstack/cs_staticnat.py
View file

@ -82,47 +82,47 @@ RETURN = '''
id:
description: UUID of the ip_address.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
ip_address:
description: Public IP address.
returned: success
type: string
type: str
sample: 1.2.3.4
vm_name:
description: Name of the virtual machine.
returned: success
type: string
type: str
sample: web-01
vm_display_name:
description: Display name of the virtual machine.
returned: success
type: string
type: str
sample: web-01
vm_guest_ip:
description: IP of the virtual machine.
returned: success
type: string
type: str
sample: 10.101.65.152
zone:
description: Name of zone the static NAT is related to.
returned: success
type: string
type: str
sample: ch-gva-2
project:
description: Name of project the static NAT is related to.
returned: success
type: string
type: str
sample: Production
account:
description: Account the static NAT is related to.
returned: success
type: string
type: str
sample: example account
domain:
description: Domain the static NAT is related to.
returned: success
type: string
type: str
sample: example domain
'''

22
lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py
View file

@ -139,12 +139,12 @@ RETURN = '''
id:
description: UUID of the pool.
returned: success
type: string
type: str
sample: a3fca65a-7db1-4891-b97c-48806a978a96
created:
description: Date of the pool was created.
returned: success
type: string
type: str
sample: 2014-12-01T14:57:57+0100
capacity_iops:
description: IOPS CloudStack can provision from this storage pool
@ -154,17 +154,17 @@ capacity_iops:
zone:
description: The name of the zone.
returned: success
type: string
type: str
sample: Zone01
cluster:
description: The name of the cluster.
returned: when scope is cluster
type: string
type: str
sample: Cluster01
pod:
description: The name of the pod.
returned: when scope is cluster
type: string
type: str
sample: Cluster01
disk_size_allocated:
description: The pool's currently allocated disk space.
@ -184,32 +184,32 @@ disk_size_used:
scope:
description: The scope of the storage pool.
returned: success
type: string
type: str
sample: cluster
hypervisor:
description: Hypervisor related to this storage pool.
returned: when available
type: string
type: str
sample: KVM
state:
description: The state of the storage pool as returned by the API.
returned: success
type: string
type: str
sample: Up
allocation_state:
description: The state of the storage pool.
returned: success
type: string
type: str
sample: enabled
path:
description: The storage pool path used in the storage_url.
returned: success
type: string
type: str
sample: poolname
overprovision_factor:
description: The overprovision factor of the storage pool.
returned: success
type: string
type: str
sample: 2.0
suitable_for_migration:
description: Whether the storage pool is suitable to migrate a volume or not.

50
lib/ansible/modules/cloud/cloudstack/cs_template.py
View file

@ -245,107 +245,107 @@ RETURN = '''
id:
description: UUID of the template or extracted object.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: Name of the template or extracted object.
returned: success
type: string
type: str
sample: Debian 7 64-bit
display_text:
description: Display text of the template.
returned: if available
type: string
type: str
sample: Debian 7.7 64-bit minimal 2015-03-19
checksum:
description: MD5 checksum of the template.
returned: if available
type: string
type: str
sample: 0b31bccccb048d20b551f70830bb7ad0
status:
description: Status of the template or extracted object.
returned: success
type: string
type: str
sample: Download Complete
is_ready:
description: True if the template is ready to be deployed from.
returned: if available
type: boolean
type: bool
sample: true
is_public:
description: True if the template is public.
returned: if available
type: boolean
type: bool
sample: true
is_featured:
description: True if the template is featured.
returned: if available
type: boolean
type: bool
sample: true
is_extractable:
description: True if the template is extractable.
returned: if available
type: boolean
type: bool
sample: true
format:
description: Format of the template.
returned: if available
type: string
type: str
sample: OVA
os_type:
description: Type of the OS.
returned: if available
type: string
type: str
sample: CentOS 6.5 (64-bit)
password_enabled:
description: True if the reset password feature is enabled, false otherwise.
returned: if available
type: boolean
type: bool
sample: false
sshkey_enabled:
description: true if template is sshkey enabled, false otherwise.
returned: if available
type: boolean
type: bool
sample: false
cross_zones:
description: true if the template is managed across all zones, false otherwise.
returned: if available
type: boolean
type: bool
sample: false
template_type:
description: Type of the template.
returned: if available
type: string
type: str
sample: USER
created:
description: Date of registering.
returned: success
type: string
type: str
sample: 2015-03-29T14:57:06+0200
template_tag:
description: Template tag related to this template.
returned: if available
type: string
type: str
sample: special
hypervisor:
description: Hypervisor related to this template.
returned: if available
type: string
type: str
sample: VMware
mode:
description: Mode of extraction
returned: on state=extracted
type: string
type: str
sample: http_download
state:
description: State of the extracted template
returned: on state=extracted
type: string
type: str
sample: DOWNLOAD_URL_CREATED
url:
description: Url to which the template is extracted to
returned: on state=extracted
type: string
type: str
sample: "http://1.2.3.4/userdata/eb307f13-4aca-45e8-b157-a414a14e6b04.ova"
tags:
description: List of resource tags associated with the template.
@ -355,22 +355,22 @@ tags:
zone:
description: Name of zone the template is registered in.
returned: success
type: string
type: str
sample: zuerich
domain:
description: Domain the template is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the template is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the template is related to.
returned: success
type: string
type: str
sample: Production
'''

26
lib/ansible/modules/cloud/cloudstack/cs_user.py
View file

@ -118,67 +118,67 @@ RETURN = '''
id:
description: UUID of the user.
returned: success
type: string
type: str
sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
username:
description: Username of the user.
returned: success
type: string
type: str
sample: johndoe
fist_name:
description: First name of the user.
returned: success
type: string
type: str
sample: John
last_name:
description: Last name of the user.
returned: success
type: string
type: str
sample: Doe
email:
description: Emailof the user.
returned: success
type: string
type: str
sample: john.doe@example.com
user_api_key:
description: API key of the user.
returned: success
type: string
type: str
sample: JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg
user_api_secret:
description: API secret of the user.
returned: success
type: string
type: str
sample: FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g
account:
description: Account name of the user.
returned: success
type: string
type: str
sample: developers
account_type:
description: Type of the account.
returned: success
type: string
type: str
sample: user
timezone:
description: Timezone of the user.
returned: success
type: string
type: str
sample: enabled
created:
description: Date the user was created.
returned: success
type: string
type: str
sample: Doe
state:
description: State of the user.
returned: success
type: string
type: str
sample: enabled
domain:
description: Domain the user is related.
returned: success
type: string
type: str
sample: ROOT
'''

22
lib/ansible/modules/cloud/cloudstack/cs_vmsnapshot.py
View file

@ -109,57 +109,57 @@ RETURN = '''
id:
description: UUID of the snapshot.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: Name of the snapshot.
returned: success
type: string
type: str
sample: snapshot before update
display_name:
description: Display name of the snapshot.
returned: success
type: string
type: str
sample: snapshot before update
created:
description: date of the snapshot.
returned: success
type: string
type: str
sample: 2015-03-29T14:57:06+0200
current:
description: true if the snapshot is current
returned: success
type: boolean
type: bool
sample: True
state:
description: state of the vm snapshot
returned: success
type: string
type: str
sample: Allocated
type:
description: type of vm snapshot
returned: success
type: string
type: str
sample: DiskAndMemory
description:
description: description of vm snapshot
returned: success
type: string
type: str
sample: snapshot brought to you by Ansible
domain:
description: Domain the vm snapshot is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the vm snapshot is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the vm snapshot is related to.
returned: success
type: string
type: str
sample: Production
'''

28
lib/ansible/modules/cloud/cloudstack/cs_volume.py
View file

@ -149,72 +149,72 @@ RETURN = '''
id:
description: ID of the volume.
returned: success
type: string
type: str
sample:
name:
description: Name of the volume.
returned: success
type: string
type: str
sample: web-volume-01
display_name:
description: Display name of the volume.
returned: success
type: string
type: str
sample: web-volume-01
group:
description: Group the volume belongs to
returned: success
type: string
type: str
sample: web
domain:
description: Domain the volume belongs to
returned: success
type: string
type: str
sample: example domain
project:
description: Project the volume belongs to
returned: success
type: string
type: str
sample: Production
zone:
description: Name of zone the volume is in.
returned: success
type: string
type: str
sample: ch-gva-2
created:
description: Date of the volume was created.
returned: success
type: string
type: str
sample: 2014-12-01T14:57:57+0100
attached:
description: Date of the volume was attached.
returned: success
type: string
type: str
sample: 2014-12-01T14:57:57+0100
type:
description: Disk volume type.
returned: success
type: string
type: str
sample: DATADISK
size:
description: Size of disk volume.
returned: success
type: string
type: str
sample: 20
vm:
description: Name of the vm the volume is attached to (not returned when detached)
returned: success
type: string
type: str
sample: web-01
state:
description: State of the volume
returned: success
type: string
type: str
sample: Attached
device_id:
description: Id of the device on user vm the volume is attached to (not returned when detached)
returned: success
type: string
type: str
sample: 1
'''

28
lib/ansible/modules/cloud/cloudstack/cs_vpc.py
View file

@ -121,72 +121,72 @@ RETURN = '''
id:
description: "UUID of the VPC."
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: "Name of the VPC."
returned: success
type: string
type: str
sample: my_vpc
display_text:
description: "Display text of the VPC."
returned: success
type: string
type: str
sample: My example VPC
cidr:
description: "CIDR of the VPC."
returned: success
type: string
type: str
sample: 10.10.0.0/16
network_domain:
description: "Network domain of the VPC."
returned: success
type: string
type: str
sample: example.com
region_level_vpc:
description: "Whether the VPC is region level or not."
returned: success
type: boolean
type: bool
sample: true
restart_required:
description: "Whether the VPC router needs a restart or not."
returned: success
type: boolean
type: bool
sample: true
distributed_vpc_router:
description: "Whether the VPC uses distributed router or not."
returned: success
type: boolean
type: bool
sample: true
redundant_vpc_router:
description: "Whether the VPC has redundant routers or not."
returned: success
type: boolean
type: bool
sample: true
domain:
description: "Domain the VPC is related to."
returned: success
type: string
type: str
sample: example domain
account:
description: "Account the VPC is related to."
returned: success
type: string
type: str
sample: example account
project:
description: "Name of project the VPC is related to."
returned: success
type: string
type: str
sample: Production
zone:
description: "Name of zone the VPC is in."
returned: success
type: string
type: str
sample: ch-gva-2
state:
description: "State of the VPC."
returned: success
type: string
type: str
sample: Enabled
tags:
description: "List of resource tags associated with the VPC."

10
lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py
View file

@ -109,27 +109,27 @@ RETURN = '''
id:
description: UUID of the vpc offering.
returned: success
type: string
type: str
sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name:
description: The name of the vpc offering
returned: success
type: string
type: str
sample: MyCustomVPCOffering
display_text:
description: The display text of the vpc offering
returned: success
type: string
type: str
sample: My vpc offering
state:
description: The state of the vpc offering
returned: success
type: string
type: str
sample: Enabled
service_offering_id:
description: The service offering ID.
returned: success
type: string
type: str
sample: c5f7a5fc-43f8-11e5-a151-feff819cdc9f
is_default:
description: Whether VPC offering is the default offering or not.

22
lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py
View file

@ -90,32 +90,32 @@ RETURN = r'''
id:
description: UUID of the VPN connection.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
vpn_gateway_id:
description: UUID of the VPN gateway.
returned: success
type: string
type: str
sample: 04589590-ac63-93f5-4ffc-b698b8ac38b6
domain:
description: Domain the VPN connection is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the VPN connection is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the VPN connection is related to.
returned: success
type: string
type: str
sample: Production
created:
description: Date the connection was created.
returned: success
type: string
type: str
sample: 2014-12-01T14:57:57+0100
dpd:
description: Whether dead pear detection is enabled or not.
@ -130,7 +130,7 @@ esp_lifetime:
esp_policy:
description: IKE policy of the VPN connection.
returned: success
type: string
type: str
sample: aes256-sha1;modp1536
force_encap:
description: Whether encapsulation for NAT traversal is enforced or not.
@ -145,7 +145,7 @@ ike_lifetime:
ike_policy:
description: ESP policy of the VPN connection.
returned: success
type: string
type: str
sample: aes256-sha1;modp1536
cidrs:
description: List of CIDRs of the customer gateway.
@ -160,17 +160,17 @@ passive:
public_ip:
description: IP address of the VPN gateway.
returned: success
type: string
type: str
sample: 10.100.212.10
gateway:
description: IP address of the VPN customer gateway.
returned: success
type: string
type: str
sample: 10.101.214.10
state:
description: State of the VPN connection.
returned: success
type: string
type: str
sample: Connected
'''

16
lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py
View file

@ -112,27 +112,27 @@ RETURN = r'''
id:
description: UUID of the VPN customer gateway.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
gateway:
description: IP address of the VPN customer gateway.
returned: success
type: string
type: str
sample: 10.100.212.10
domain:
description: Domain the VPN customer gateway is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the VPN customer gateway is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the VPN customer gateway is related to.
returned: success
type: string
type: str
sample: Production
dpd:
description: Whether dead pear detection is enabled or not.
@ -147,7 +147,7 @@ esp_lifetime:
esp_policy:
description: IKE policy of the VPN customer gateway.
returned: success
type: string
type: str
sample: aes256-sha1;modp1536
force_encap:
description: Whether encapsulation for NAT traversal is enforced or not.
@ -162,12 +162,12 @@ ike_lifetime:
ike_policy:
description: ESP policy of the VPN customer gateway.
returned: success
type: string
type: str
sample: aes256-sha1;modp1536
name:
description: Name of this customer gateway.
returned: success
type: string
type: str
sample: my vpn customer gateway
cidrs:
description: List of CIDRs of this customer gateway.

12
lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py
View file

@ -80,32 +80,32 @@ RETURN = '''
id:
description: UUID of the VPN site-to-site gateway.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
public_ip:
description: IP address of the VPN site-to-site gateway.
returned: success
type: string
type: str
sample: 10.100.212.10
vpc:
description: Name of the VPC.
returned: success
type: string
type: str
sample: My VPC
domain:
description: Domain the VPN site-to-site gateway is related to.
returned: success
type: string
type: str
sample: example domain
account:
description: Account the VPN site-to-site gateway is related to.
returned: success
type: string
type: str
sample: example account
project:
description: Name of project the VPN site-to-site gateway is related to.
returned: success
type: string
type: str
sample: Production
'''

30
lib/ansible/modules/cloud/cloudstack/cs_zone.py
View file

@ -118,62 +118,62 @@ RETURN = '''
id:
description: UUID of the zone.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the zone.
returned: success
type: string
type: str
sample: zone01
dns1:
description: First DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.8.8
dns2:
description: Second DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.4.4
internal_dns1:
description: First internal DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.8.8
internal_dns2:
description: Second internal DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.4.4
dns1_ipv6:
description: First IPv6 DNS for the zone.
returned: success
type: string
type: str
sample: "2001:4860:4860::8888"
dns2_ipv6:
description: Second IPv6 DNS for the zone.
returned: success
type: string
type: str
sample: "2001:4860:4860::8844"
allocation_state:
description: State of the zone.
returned: success
type: string
type: str
sample: Enabled
domain:
description: Domain the zone is related to.
returned: success
type: string
type: str
sample: ROOT
network_domain:
description: Network domain for the zone.
returned: success
type: string
type: str
sample: example.com
network_type:
description: Network type for the zone.
returned: success
type: string
type: str
sample: basic
local_storage_enabled:
description: Local storage offering enabled.
@ -188,17 +188,17 @@ securitygroups_enabled:
guest_cidr_address:
description: Guest CIDR address for the zone
returned: success
type: string
type: str
sample: 10.1.1.0/24
dhcp_provider:
description: DHCP provider for the zone
returned: success
type: string
type: str
sample: VirtualRouter
zone_token:
description: Zone token
returned: success
type: string
type: str
sample: ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7
tags:
description: List of resource tags associated with the zone.

30
lib/ansible/modules/cloud/cloudstack/cs_zone_facts.py
View file

@ -48,62 +48,62 @@ RETURN = '''
id:
description: UUID of the zone.
returned: success
type: string
type: str
sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
name:
description: Name of the zone.
returned: success
type: string
type: str
sample: zone01
dns1:
description: First DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.8.8
dns2:
description: Second DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.4.4
internal_dns1:
description: First internal DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.8.8
internal_dns2:
description: Second internal DNS for the zone.
returned: success
type: string
type: str
sample: 8.8.4.4
dns1_ipv6:
description: First IPv6 DNS for the zone.
returned: success
type: string
type: str
sample: "2001:4860:4860::8888"
dns2_ipv6:
description: Second IPv6 DNS for the zone.
returned: success
type: string
type: str
sample: "2001:4860:4860::8844"
allocation_state:
description: State of the zone.
returned: success
type: string
type: str
sample: Enabled
domain:
description: Domain the zone is related to.
returned: success
type: string
type: str
sample: ROOT
network_domain:
description: Network domain for the zone.
returned: success
type: string
type: str
sample: example.com
network_type:
description: Network type for the zone.
returned: success
type: string
type: str
sample: basic
local_storage_enabled:
description: Local storage offering enabled.
@ -118,17 +118,17 @@ securitygroups_enabled:
guest_cidr_address:
description: Guest CIDR address for the zone
returned: success
type: string
type: str
sample: 10.1.1.0/24
dhcp_provider:
description: DHCP provider for the zone
returned: success
type: string
type: str
sample: VirtualRouter
zone_token:
description: Zone token
returned: success
type: string
type: str
sample: ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7
tags:
description: List of resource tags associated with the zone.