Nota

Questo plugin fa parte del pacchetto raccolta community.aws (versione 1.3.0).

Per installarlo, usare: ansible-galaxy collection install community.aws.

Per usarlo in un playbook, specificare: community.aws.ec2_vpc_vpn_info.

Novità della versione 1.0.0: di community.aws

  • Sinossi
  • Requisiti
  • Parametri
  • Note
  • Esempi
  • Valori di ritorno

Sinossi

  • Raccoglie informazioni sulle connessioni VPN in AWS.
  • Questo modulo è stato chiamato ec2_vpc_vpn_facts prima di Ansible 2.9. L'uso non è cambiato.

Requisiti

I requisiti seguenti sono necessari sull'host che esegue questo modulo.

  • boto
  • boto3
  • python >= 2.6

Parametri

Parametri Scelte/Defaults Commenti
chiave_accesso_awsstringa Chiave di accesso AWS. Se non è impostata, viene utilizzato il valore della variabile d'ambiente AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY o EC2_ACCESS_KEY. profilo è impostato, questo parametro viene ignorato.Passando il parametro aws_access_key e profilo allo stesso tempo è stata deprecata e le opzioni saranno rese mutuamente esclusive dopo il 2022-06-01.
alias: ec2_access_key, access_key
aws_ca_bundlepercorso Solo per i moduli basati su boto3. Nota: il bundle CA viene letto dal lato 'modulo' e può essere necessario copiarlo esplicitamente dal controllore se non viene eseguito localmente.
aws_configdizionario Un dizionario per modificare la configurazione del botocore.I parametri possono essere trovati in https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config Solo la chiave 'user_agent' viene utilizzata per i moduli boto. Vedere http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto per ulteriori configurazioni di boto.
aws_secret_keystringa Chiave segreta AWS. Se non è impostata, viene utilizzato il valore della variabile d'ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY o EC2_SECRET_KEY. profilo è impostato, questo parametro viene ignorato.Passando il parametro aws_secret_key e profilo allo stesso tempo è stata deprecata e le opzioni saranno rese mutuamente esclusive dopo il 2022-06-01.
alias: ec2_secret_key, secret_key
debug_botocore_endpoint_logsbooleano
    Scelte:

  • no
Utilizzare un logger botocore.endpoint per analizzare le chiamate API "resource:action" uniche (anziché totali) effettuate durante un'attività, inviando l'insieme alla chiave resource_actions nei risultati dell'attività. Utilizzare il callback aws_resource_action per ottenere l'elenco totale effettuato durante una playbook. È possibile utilizzare anche la variabile d'ambiente ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_urlstringa Url da usare per connettersi a EC2 o al proprio cloud Eucalyptus (per impostazione predefinita il modulo userà gli endpoint di EC2). Ignorato per i moduli in cui è richiesta la regione. Deve essere specificato per tutti gli altri moduli se la regione non è utilizzata. Se non è impostato, viene utilizzato il valore della variabile d'ambiente EC2_URL, se presente.
alias: aws_endpoint_url, endpoint_url
filtridizionario Un dizionario di filtri da applicare. Ogni elemento del dizionario è costituito da una chiave di filtro e da un valore di filtro. Vedere https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html per i possibili filtri.
profilostringa Utilizza un profilo di boto. Funziona solo con boto >= 2.24.0.Using profilo sovrascrive il profilo chiave_accesso_aws, aws_secret_key e security_token e il supporto per passarli contemporaneamente a profilo è stato deprecato.chiave_accesso_aws, aws_secret_key e security_token saranno resi mutuamente esclusivi con profilo dopo il 2022-06-01.
alias: aws_profile
regionestringa La regione AWS da utilizzare. Se non viene specificata, viene utilizzato il valore della variabile d'ambiente AWS_REGION o EC2_REGION, se presente. Vedere http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
alias: aws_region, ec2_region
token di sicurezzastringa Token di sicurezza AWS STS. Se non è impostato, viene utilizzato il valore della variabile d'ambiente AWS_SECURITY_TOKEN o EC2_SECURITY_TOKEN. profilo è impostato, questo parametro viene ignorato.Passando il parametro token_di_sicurezza e profilo allo stesso tempo è stata deprecata e le opzioni saranno rese mutuamente esclusive dopo il 2022-06-01.
alias: aws_security_token, access_token
validate_certsbooleano
    Scelte:

  • no
Se impostato su "no", i certificati SSL non verranno convalidati per le versioni di boto >= 2.6.0.
vpn_connection_idselenco / elementi=stringa Ottiene i dettagli di una specifica connessione VPN utilizzando gli ID/ID della connessione vpn. Questo valore deve essere fornito come elenco.

Note

Nota

  • Se i parametri non sono impostati all'interno del modulo, è possibile utilizzare le seguenti variabili d'ambiente in ordine decrescente di precedenza AWS_URL o EC2_URL, AWS_PROFILE o AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID o AWS_ACCESS_KEY o EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY o AWS_SECRET_KEY o EC2_SECRET_KEY, AWS_SECURITY_TOKEN o EC2_SECURITY_TOKEN, AWS_REGION o EC2_REGION, AWS_CA_BUNDLE
  • Ansible utilizza il file di configurazione di boto (tipicamente ~/.boto) se non vengono fornite le credenziali. Vedere https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION o EC2_REGION possono essere utilizzati per specificare la regione AWS, se necessario, ma possono anche essere configurati nel file di configurazione di boto

Esempi

# # Note: These examples do not set authentication details, see the AWS Guide for details.-name: Gather information about all vpn connections
  community.aws.ec2_vpc_vpn_info:-name: Gather information about a filtered list of vpn connections, based on tags
  community.aws.ec2_vpc_vpn_info:filters:"tag:Name": test-connection
  register: vpn_conn_info

-name: Gather information about vpn connections by specifying connection IDs.
  community.aws.ec2_vpc_vpn_info:filters:vpn-gateway-id: vgw-cbe66beb
  register: vpn_conn_info

Valori di ritorno

I valori di ritorno più comuni sono documentati qui, i seguenti sono i campi unici di questo modulo:

Chiave Restituito Descrizione
vpn_connessionicomplesso sempre Elenco di una o più connessioni VPN.
categoriastringa sempre La categoria della connessione VPN.
Esempio: VPN
ID_cliente_gatewaystringa sempre L'ID del gateway cliente all'estremità della connessione VPN.
Esempio: cgw-17a53c37
configurazione_cliente_gatwaystringa sempre Le informazioni di configurazione del gateway cliente della connessione VPN (nel formato XML nativo).
opzionidizionario sempre Le opzioni di connessione VPN.
Esempio:{'static_routes_only': False}
rottecomplesso sempre Elenco delle rotte statiche associate alla connessione VPN.
blocco_destinazione_cidrstringa sempre Il blocco CIDR associato alla sottorete locale del centro dati del cliente.
Esempio: 10.0.0.0/16
statostringa sempre Lo stato attuale del percorso statico.
Esempio: disponibile
statostringa sempre Lo stato attuale della connessione VPN.
Esempio: disponibile
etichettedizionario sempre Qualsiasi tag assegnato alla connessione VPN.
Esempio:{'Nome': 'test-conn'}
tipostringa sempre Il tipo di connessione VPN.
Esempio: ipsec.1
vgw_telemetriacomplesso sempre Informazioni sul tunnel VPN.
numero_di_route_accettateintero sempre Il numero di rotte accettate.
certificato_arnstringa quando viene utilizzato un certificato privato per l'autenticazione Il nome della risorsa Amazon del certificato dell'endpoint del tunnel del gateway privato virtuale.
Esempio: arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example
ultimo_stato_modificatostringa sempre Data e ora dell'ultima modifica dello stato.
Esempio: 2018-02-09T14:35:27+00:00
indirizzo_ip_esternostringa sempre L'indirizzo IP instradabile a Internet dell'interfaccia esterna del gateway privato virtuale.
Esempio: 13.127.79.191
statostringa sempre Lo stato del tunnel VPN.
Esempio: GIU'
messaggio_di_statostringa sempre Se si verifica un errore, una descrizione dell'errore.
Esempio: IPSEC È DISATTIVATO
vpn_connection_idstringa sempre L'ID della connessione VPN.
Esempio: vpn-f700d5c0
vpn_gateway_idstringa sempre L'ID del gateway privato virtuale sul lato AWS della connessione VPN.
Esempio: vgw-cbe56bfb

Autori

  • Madhura Naniwadekar (@Madhura-CSI)