pureport.pureport.supported_connections_info (0.0.9) — module

Install collection

Install with ansible-galaxy collection install pureport.pureport:==0.0.9

Add to requirements.yml

  collections:
    - name: pureport.pureport
      version: 0.0.9

Description

Retrieve a list of supported connections for an account

Requirements

• pureport-client

Usage examples

Scanned by Steampunk Spotter

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

- name: List supported connections for an account
  supported_connections_info:
    api_key: XXXXXXXXXXXXX
    api_secret: XXXXXXXXXXXXXXXXX
    account_href: /accounts/ac-XXXXXXXXXXXXXXXXXXXXXX
  register: result   # Registers result.supported_connections

Scanned by Steampunk Spotter

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

- name: Display all supported connection hrefs using a json_query filter
  debug:
    var: item
  loop: "{{ result.supported_connections | json_query('[*].href') }}"

Inputs

    
api_key:
    description:
    - The pre-configured API Key for a Pureport Account.
    - Users should provide either the 'api_key' and 'api_secret' or the obtained 'api_access_token'.
    required: false
    type: str

api_secret:
    description:
    - The pre-configured API Secret for a Pureport Account.
    - Users should provide either the 'api_key' and 'api_secret' or the obtained 'api_access_token'.
    required: false
    type: str

account_href:
    description:
    - The Pureport Account object.
    - This should be the full 'href' path to the Account ReST object (e.g /accounts/abc).
    required: true
    type: str

api_base_url:
    description:
    - The host url for the Pureport API.
    required: false
    type: str

api_access_token:
    description:
    - The access token to use with Pureport API.  This can be obtained from
    - the `pureport_access_token_fact` module.
    - Users should provide either the 'api_key' and 'api_secret' or the obtained 'api_access_token'.
    type: str

Outputs

supported_connections:
  contains:
    billing_plans:
      contains:
        amount:
          description:
          - The amount in cents for this plan.
          returned: success
          sample: 15
          type: int
        billing_interval:
          description:
          - The time period billing is accumulated and sent to the user for payment.
          returned: success
          sample: MONTH
          type: str
        id:
          description:
          - The billing plan id.
          returned: success
          sample: plan_EJ36MVNfXZ7C3x
          type: str
        term:
          description:
          - The frequency at which the 'amount' is accumulated with this connection
            plan.
          returned: success
          sample: HOURLY
          type: str
      description:
      - A list of supported billing plans for this supported connection.
      returned: success
      type: complex
    billing_product_id:
      description:
      - The billing product id, a reference to the billing plan for this connection.
      returned: success
      sample: prod_EJ36Dg42H2a9AX
      type: str
    groups:
      contains:
        href:
          description:
          - The supported connection group href.
          returned: success
          sample: /supportedConnections/groups/default
          type: str
        id:
          description:
          - The supported connection group id.
          returned: success
          sample: default
          type: str
        title:
          description:
          - The supported connection group name.
          returned: success
          sample: Default
          type: str
      description:
      - A list of Supported Group Link objects this Supported Connection belongs to.
      returned: success
      type: complex
    high_availability:
      description:
      - If the connection supports high availability.
      returned: success
      sample: false
      type: bool
    href:
      description:
      - The supported connection href, a path to resource on the server.
      returned: success
      sample: /supportedConnections/us-sea-awsdx-private-50-noha
      type: str
    id:
      description:
      - The supported connection id.
      returned: success
      sample: us-sea-awsdx-private-50-noha
      type: str
    location:
      contains:
        href:
          description:
          - The location href.
          returned: success
          sample: /locations/us-sea
          type: str
        id:
          description:
          - The location id.
          returned: success
          sample: us-sea
          type: str
        title:
          description:
          - The location name.
          returned: success
          sample: Seattle, WA
          type: str
      description:
      - The Location Link object of the supported connection.
      returned: success
      type: complex
    peering_type:
      description:
      - The peering type of the supported connection.
      returned: success
      sample: PRIVATE
      type: str
    reachable_cloud_Regions:
      contains:
        href:
          description:
          - The cloud region href.
          returned: success
          sample: /cloudRegions/aws-us-west-2
          type: str
        id:
          description:
          - The cloud region id.
          returned: success
          sample: aws-us-west-2
          type: str
        title:
          description:
          - The cloud region name.
          returned: success
          sample: US West (Oregon)
          type: str
      description:
      - A list of Cloud Region Link objects supported by the supported connection.
      returned: success
      type: complex
    speed:
      description:
      - The speed of the supported connection.
      returned: success
      sample: 50
      type: int
    type:
      description:
      - The connection type that is supported.
      returned: success
      sample: AWS_DIRECT_CONNECT
      type: str
  description: A list of SupportedConnection (dict) objects.
  returned: success
  type: complex