ansible.builtin.cs_zone_facts (v2.5.11) — module

Gathering facts of zones from Apache CloudStack based clouds.

| "added in version" 2.1 of ansible.builtin"

Authors: René Moser (@resmo)

stableinterface | supported by community

Install Ansible via pip

Install with pip install ansible==2.5.11

Description

Gathering facts from the API of a zone.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- cs_zone_facts:
    name: ch-gva-1
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    var: cloudstack_zone

Inputs

    
name:
    aliases:
    - zone
    description:
    - Name of the zone.
    required: true

api_key:
    description:
    - API key of the CloudStack API.
    - If not given, the C(CLOUDSTACK_KEY) env variable is considered.
    required: true
    type: str

api_url:
    description:
    - URL of the CloudStack API e.g. https://cloud.example.com/client/api.
    - If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered.
    required: true
    type: str

api_secret:
    description:
    - Secret key of the CloudStack API.
    - If not set, the C(CLOUDSTACK_SECRET) env variable is considered.
    required: true
    type: str

api_timeout:
    default: 10
    description:
    - HTTP timeout in seconds.
    - If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered.
    type: int

api_http_method:
    choices:
    - get
    - post
    default: get
    description:
    - HTTP method used to query the API endpoint.
    - If not given, the C(CLOUDSTACK_METHOD) env variable is considered.
    type: str

api_verify_ssl_cert:
    description:
    - Verify CA authority cert file.
    - If not given, the C(CLOUDSTACK_VERIFY) env variable is considered.
    type: str

Outputs

cloudstack_zone.allocation_state:
  description: State of the zone.
  returned: success
  sample: Enabled
  type: string
cloudstack_zone.dhcp_provider:
  description: DHCP provider for the zone
  returned: success
  sample: VirtualRouter
  type: string
cloudstack_zone.dns1:
  description: First DNS for the zone.
  returned: success
  sample: 8.8.8.8
  type: string
cloudstack_zone.dns1_ipv6:
  description: First IPv6 DNS for the zone.
  returned: success
  sample: 2001:4860:4860::8888
  type: string
cloudstack_zone.dns2:
  description: Second DNS for the zone.
  returned: success
  sample: 8.8.4.4
  type: string
cloudstack_zone.dns2_ipv6:
  description: Second IPv6 DNS for the zone.
  returned: success
  sample: 2001:4860:4860::8844
  type: string
cloudstack_zone.domain:
  description: Domain the zone is related to.
  returned: success
  sample: ROOT
  type: string
cloudstack_zone.guest_cidr_address:
  description: Guest CIDR address for the zone
  returned: success
  sample: 10.1.1.0/24
  type: string
cloudstack_zone.id:
  description: UUID of the zone.
  returned: success
  sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
  type: string
cloudstack_zone.internal_dns1:
  description: First internal DNS for the zone.
  returned: success
  sample: 8.8.8.8
  type: string
cloudstack_zone.internal_dns2:
  description: Second internal DNS for the zone.
  returned: success
  sample: 8.8.4.4
  type: string
cloudstack_zone.local_storage_enabled:
  description: Local storage offering enabled.
  returned: success
  sample: false
  type: bool
cloudstack_zone.name:
  description: Name of the zone.
  returned: success
  sample: zone01
  type: string
cloudstack_zone.network_domain:
  description: Network domain for the zone.
  returned: success
  sample: example.com
  type: string
cloudstack_zone.network_type:
  description: Network type for the zone.
  returned: success
  sample: basic
  type: string
cloudstack_zone.securitygroups_enabled:
  description: Security groups support is enabled.
  returned: success
  sample: false
  type: bool
cloudstack_zone.tags:
  description: List of resource tags associated with the zone.
  returned: success
  sample:
  - key: foo
    value: bar
  type: dict
cloudstack_zone.zone_token:
  description: Zone token
  returned: success
  sample: ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7
  type: string