gcore.cloud.securitygroup_info (1.0.1) — module

Install collection

Install with ansible-galaxy collection install gcore.cloud:==1.0.1

Add to requirements.yml

  collections:
    - name: gcore.cloud
      version: 1.0.1

Description

Gather infos about all GCore securitygroups.

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather gcore securitygroup infos
  gcore.cloud.securitygroup_info:
    api_key: "{{ api_key }}"
    region_id: "{{ region_id }}"
    project_id: "{{ project_id }}"

Scanned by Steampunk Spotter

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

- name: Gather gcore specific securitygroup info
  gcore.cloud.securitygroup_info:
    api_key: "{{ api_key }}"
    region_id: "{{ region_id }}"
    project_id: "{{ project_id }}"
    securitygroup_id: "{{ securitygroup_id }}"

Inputs

    
limit:
    description:
    - Limit the number of returned limit request entities.
    required: false
    type: int

offset:
    description:
    - Offset value is used to exclude the first set of records from the result.
    required: false
    type: int

api_key:
    description:
    - GCore API auth key
    - Can be passed as I(CLOUD_API_KEY) environment variable.
    type: str

api_host:
    default: https://api.gcore.com/cloud
    description:
    - GCore API base host
    - Can be passed as I(CLOUD_API_HOST) environment variable.
    type: str

region_id:
    description:
    - GCore API region ID
    - Required if I(region_name) is not passed
    - Can be passed as I(CLOUD_REGION_ID) environment variable.
    type: int

metadata_k:
    description:
    - Filter by metadata keys. Must be a valid JSON string.
    required: false
    type: str

project_id:
    description:
    - GCore API project ID
    - Required if I(project_name) is not passed
    - Can be passed as I(CLOUD_PROJECT_ID) environment variable.
    type: int

api_timeout:
    default: 30
    description:
    - Timeout in seconds to polling GCore API
    type: int

metadata_kv:
    description:
    - Filter by metadata key-value pairs. Must be a valid JSON string.
    required: false
    type: str

region_name:
    description:
    - GCore API region name
    - Required if I(region_id) is not passed
    - Can be passed as I(CLOUD_REGION_NAME) environment variable.
    type: str

project_name:
    description:
    - GCore API project name
    - Required if I(project_id) is not passed
    - Can be passed as I(CLOUD_PROJECT_NAME) environment variable.
    type: str

securitygroup_id:
    description:
    - The ID of securitygroup you want to get.
    - The module will fail if the provided ID is invalid.
    required: false
    type: str

Outputs

securitygroup_info:
  contains:
    created_at:
      description: Datetime when the security group was created
      returned: always
      sample: 2019-07-26T13:25:03+0000
      type: str
    description:
      description: Security group description
      returned: always
      sample: Default security group
      type: str
    id:
      description: Security group ID
      returned: always
      sample: 3addc7a1-e926-46da-b5a2-eb4b2f935230
      type: str
    metadata:
      description: Network metadata
      elements: dict
      returned: always
      sample:
      - key: hosting
        read_only: false
        value: some value
      type: list
    name:
      description: Security group name
      returned: always
      sample: default
      type: str
    project_id:
      description: Project ID
      returned: always
      sample: 1
      type: int
    region:
      description: Region name
      returned: always
      sample: Luxembourg 1
      type: str
    region_id:
      description: Region ID
      returned: always
      sample: 1
      type: int
    revision_number:
      description: The number of revisions
      returned: always
      sample: 0
      type: int
    security_group_rules:
      description: Security group rules
      elements: dict
      returned: always
      sample:
      - created_at: 2019-07-26T13:25:03+0000
        description: None
        direction: egress
        ethertype: IPv4
        id: 253c1ad7-8061-44b9-9f33-5616ad8ba5b6
        port_range_max: None
        port_range_min: None
        protocol: None
        remote_group_id: None
        remote_ip_prefix: None
        revision_number: 0
        security_group_id: 3addc7a1-e926-46da-b5a2-eb4b2f935230
        updated_at: 2019-07-26T13:25:03+0000
      type: list
    tags:
      description: Security group tags
      elements: str
      returned: always
      sample:
      - hosting
      type: list
    updated_at:
      description: Datetime when the security group was last updated
      returned: always
      sample: 2019-07-26T13:25:03+0000
      type: str
  description:
  - When I(securitygroup_id) is passed, it is a dict of resource.
  - Otherwise it is a list of dictionaries.
  returned: always
  type: complex

See also

• Documentation for GCore Cloud API: Complete public API documentation. link