Skip to content

Latest commit

 

History

History
702 lines (656 loc) · 31.6 KB

community.missing_collection.aws_directconnect_info_module.rst

File metadata and controls

702 lines (656 loc) · 31.6 KB

community.missing_collection.aws_directconnect_info

Get Information about AWS Direct Connect.

Version added: 0.0.5

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
describe_connections
boolean
    Choices:
  • no
  • yes
do you want to get details about given connection id?
describe_connections_on_interconnect
boolean
    Choices:
  • no
  • yes
do you want to get details about connections of given interconnect id?
describe_direct_connect_gateway_association_proposals
boolean
    Choices:
  • no
  • yes
do you want to get details of association proposals of given direct connect gateway id?
describe_direct_connect_gateway_attachments
boolean
    Choices:
  • no
  • yes
do you want to get details of association attachments of given direct connect gateway id?
describe_hosted_connections
boolean
    Choices:
  • no
  • yes
do you want to get details about given hosted connections of given connection id?
describe_interconnects
boolean
    Choices:
  • no
  • yes
do you want to get details about given interconnect id?
describe_lags
boolean
    Choices:
  • no
  • yes
do you want to get details about link aggregation groups (LAG) of given lag id?
describe_loa
boolean
    Choices:
  • no
  • yes
do you want to get details about the LOA-CFA for a connection id?
describe_locations
boolean
    Choices:
  • no
  • yes
do you want to get details of direct connect locations?
describe_virtual_gateways
boolean
    Choices:
  • no
  • yes
do you want to get details about all virtual gateways?
describe_virtual_interfaces
boolean
    Choices:
  • no
  • yes
do you want to get details about virtual interfaces of given connection id?
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
id
string
can be id of connection, interconnect, direct_connect_gateway or lag?

aliases: connection_id, interconnect_id, direct_connect_gateway_id, lag_id
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: "Gets detailed of all the direct connect gateways"
  aws_directconnect_info:

- name: "get details about given connection"
  aws_directconnect_info:
    describe_connections: true
    id: 'test-connection-id'

- name: "get details about connections of given interconnect"
  aws_directconnect_info:
    describe_connections_on_interconnect: true
    id: 'test-interconnect-id'

- name: "get details about given connection"
  aws_directconnect_info:
    describe_connections: true
    id: 'test-connection-id'

- name: "get details of association proposals of given direct connect gateway"
  aws_directconnect_info:
    describe_direct_connect_gateway_association_proposals: true
    id: 'test-connect-gateway-id'

- name: "get details of association attachments of given direct connect gateway"
  aws_directconnect_info:
    describe_direct_connect_gateway_attachments: true
    id: 'test-connect-gateway-id'

- name: "get details about given hosted connections"
  aws_directconnect_info:
    describe_hosted_connections: true
    id: 'test-connection-id'

- name: "get details about given interconnect"
  aws_directconnect_info:
    describe_interconnects: true
    id: 'test-interconnect-id'

- name: "gget details about link aggregation groups (LAG)"
  aws_directconnect_info:
    describe_lags: true
    id: 'test-connection-id'

- name: "get details about the LOA-CFA for a connection"
  aws_directconnect_info:
    describe_loa: true
    id: 'test-lag-id'

- name: "get details of direct connect locations"
  aws_directconnect_info:
    describe_locations: true

- name: "get details about all virtual gateways"
  aws_directconnect_info:
    describe_virtual_gateways: true

- name: "get details about virtual interfaces of given connection"
  aws_directconnect_info:
    describe_virtual_interfaces: true
    id: 'test-connection-id'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
connections
list
when `describe_connections` or `describe_connections_on_interconnect` or `describe_hosted_connections` are defined and success
detailed about direct connect connections.
direct_connect_gateway_association_proposals
list
when `describe_direct_connect_gateway_association_proposals` is defined and success
get details of association proposals of given direct connect gateway
direct_connect_gateway_attachments
list
when `describe_direct_connect_gateway_attachments` is defined and success
get details of association attachments of given direct connect gateway
direct_connect_gateways
list
when no arguments are defined and success
list of direct connect gateways
interconnects
list
when `describe_interconnects` is defined and success
get details about given interconnect
lags
list
when `describe_lags` is defined and success
get details about link aggregation groups (LAG)
loa
list
when `describe_loa` is defined and success
get details about the LOA-CFA
locations
list
when `describe_locations` is defined and success
get details of direct connect locations
virtual_gateways
list
when `describe_virtual_gateways` is defined and success
get details about all virtual gateways
virtual_interfaces
list
when `describe_virtual_interfaces` is defined and success
get details about virtual interfaces


Status

Authors