community.digitalocean.digital_ocean_project_info (1.26.0) — module

Install collection

Install with ansible-galaxy collection install community.digitalocean:==1.26.0

Add to requirements.yml

  collections:
    - name: community.digitalocean
      version: 1.26.0

Description

This module can be used to gather information about Projects.

Usage examples

Scanned by Steampunk Spotter

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

# Get specific project by id
- community.digitalocean.digital_ocean_project_info:
    id: cb1ef55e-3cd8-4c7c-aa5d-07c32bf41627

Scanned by Steampunk Spotter

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

# Get specific project by name
- community.digitalocean.digital_ocean_project_info:
    name: my-project-name

Scanned by Steampunk Spotter

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

# Get all projects
- community.digitalocean.digital_ocean_project_info:
  register: projects

Inputs

    
id:
    description:
    - Project ID that can be used to identify and reference a project.
    type: str

name:
    description:
    - Project name that can be used to identify and reference a project.
    type: str

baseurl:
    default: https://api.digitalocean.com/v2
    description:
    - DigitalOcean API base url.
    type: str

timeout:
    default: 30
    description:
    - The timeout in seconds used for polling DigitalOcean's API.
    type: int

oauth_token:
    aliases:
    - api_token
    description:
    - DigitalOcean OAuth token.
    - There are several other environment variables which can be used to provide this
      value.
    - i.e., - C(DO_API_TOKEN), C(DO_API_KEY), C(DO_OAUTH_TOKEN) and C(OAUTH_TOKEN).
    type: str

validate_certs:
    default: true
    description:
    - If set to C(no), the 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

data:
  description: DigitalOcean project information
  elements: dict
  returned: success
  sample:
  - created_at: '2021-03-11T00:00:00Z'
    description: My project description
    environment: Development
    id: 12345678-abcd-efgh-5678-10111213
    is_default: false
    name: my-test-project
    owner_id: 12345678
    owner_uuid: 12345678-1234-4321-abcd-20212223
    purpose: ''
    updated_at: '2021-03-11T00:00:00Z'
  type: list