esp.terraform.tfe_remote_state_consumers_info (0.1.0) — module

Install collection

Install with ansible-galaxy collection install esp.terraform:==0.1.0

Add to requirements.yml

  collections:
    - name: esp.terraform
      version: 0.1.0

Description

Retrieves the list of other workspaces that are allowed to access the given workspace's state during runs.

A workspace may be referred either by its id or its name.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Remote State Consumers
  esp.terraform.tfe_remote_state_consumers_info:
    url: 'https://terraform.example.com'
    token: '{{ token }}'
    organization: foo
    workspace: my-workspace
    validate_certs: no
  register: _result

Inputs

    
url:
    description:
    - Terraform Enterprise URL.
    required: false
    type: str

sleep:
    default: 5
    description:
    - Number of seconds to sleep between API retries.
    type: int

token:
    description:
    - All requests to Terraform Enterprise must be authenticated with a bearer token.
    - There are three kinds of token available, i.e. user tokens, team tokens and organization
      tokens.
    - See L(Authentication,https://www.terraform.io/docs/cloud/api/index.html#authentication).
    required: true
    type: str

retries:
    default: 3
    description:
    - Number of retries to call Terraform API URL before failure.
    type: int

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

workspace:
    description:
    - The Workspace name or ID.
    required: true
    type: str

organization:
    description:
    - Organization name.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

json:
  contains:
    data:
      description: Details on workspaces.
      elements: dict
      returned: success
      sample:
      - attributes:
          execution-mode: remote
          locked: false
          name: my-workspace-2
        id: ws-c4QU38B37cuh873N
        type: workspaces
      type: list
  description: Details on workspaces.
  returned: success
  type: dict
organization:
  description: Organization name or external-id.
  returned: always
  sample: foo
  type: str