opentelekomcloud.cloud.security_group_info (0.14.2) — module

Lists security groups

| "added in version" 0.1.2 of opentelekomcloud.cloud"

Authors: Tino Schreiber (@tischrei)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

List security groups


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get specific security group
- opentelekomcloud.cloud.security_group_info:
    name: "{{ my_sg }}"
  register: sg
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get all security groups
- opentelekomcloud.cloud.security_group_info:
  register: sg

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

name:
    description:
    - Name or id of the security group.
    type: str

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

project_id:
    description:
    - Specifies the project id as filter criteria
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

description:
    description:
    - Description of the security group
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

Outputs

security_groups:
  contains:
    created_at:
      description: Creation time of the security group
      sample: yyyy-mm-dd hh:mm:ss
      type: str
    description:
      description: Description of the security group
      sample: My security group
      type: str
    id:
      description: ID of the security group
      sample: d90e55ba-23bd-4d97-b722-8cb6fb485d69
      type: str
    name:
      description: Name of the security group.
      sample: my-sg
      type: str
    project_id:
      description: Project ID where the security group is located in.
      sample: 25d24fc8-d019-4a34-9fff-0a09fde6a567
      type: str
    security_group_rules:
      description: Specifies the security group rule list
      sample:
      - description: null
        direction: ingress
        ethertype: IPv4
        id: d90e55ba-23bd-4d97-b722-8cb6fb485d69
        port_range_max: null
        port_range_min: null
        protocol: null
        remote_group_id: 0431c9c5-1660-42e0-8a00-134bec7f03e2
        remote_ip_prefix: null
        security_group_id: 0431c9c5-1660-42e0-8a00-134bec7f03e2
        tenant_id: bbfe8c41dd034a07bebd592bf03b4b0c
      - description: null
        direction: egress
        ethertype: IPv4
        id: aecff4d4-9ce9-489c-86a3-803aedec65f7
        port_range_max: null
        port_range_min: null
        protocol: null
        remote_group_id: null
        remote_ip_prefix: null
        security_group_id: 0431c9c5-1660-42e0-8a00-134bec7f03e2
        tenant_id: bbfe8c41dd034a07bebd592bf03b4b0c
      type: list
    updated_at:
      description: Update time of the security group
      sample: yyyy-mm-dd hh:mm:ss
      type: str
  description: List of dictionaries describing security groups.
  returned: On Success.
  type: complex