EFS Info

5 min

Sinopse

Este módulo pode ser usado para pesquisar sistemas de arquivos do Amazon EFS.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
aws_access_key aliases: ec2_access_key, access_key	string		AWS access key. Se não for definido, o valor da variável AWS_ACCESS_KEY_ID de ambiente AWS_ACCESS_KEY ou EC2_ACCESS_KEY será usado. Se o profile for definido, este parâmetro será ignorado.
aws_ca_bundle	path		A localização de um CA Bundle a ser usado ao validar certificados SSL. Não usado por módulos baseados em boto 2.
aws_config	dictionary		Um dicionário para modificar a configuração do botocore. Os parâmetros podem ser encontrados em https://botocore.amazonaws.com. Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com para obter mais configurações de boto.
aws_secret_key aliases: ec2_secret_key, secret_key	string		AWS secret key. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY será usado. Se o profile for definido, este parâmetro será ignorado.
debug_botocore_endpoint_logs	boolean	Escolhas: false ← (padrão) true	Use um registrador botocore.endpoint para analisar as chamadas de API “resource:action” exclusivas (em vez de totais) feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa. Use o retorno de chamada aws_resource_action para gerar a lista total feita durante um playbook.
ec2_url aliases: aws_endpoint_url, endpoint_url	string		URL a ser usada para conectar-se ao EC2 ou à sua nuvem Eucalyptus (por padrão, o módulo usará endpoints do EC2). Ignorado para módulos onde a região é necessária. Deve ser especificado para todos os outros módulos se a região não for usada. Se não for definido, o valor da variável de ambiente EC2_URL, se houver, será usado.
ID	string		ID do Amazon EFS.
name aliases: creation_token	string		Token de criação do sistema de arquivos do Amazon EFS.
profile aliases: aws_profile	string		O uso do profile substituirá aws_access_key , aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que o profile foi descontinuado.
região aliases: aws_region, ec2_region	string		A região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado. Consulte http://docs.aws.amazon.com
security_token aliases: aws_security_token, access_token	string		AWS STS security token. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado. Se o profile for definido, este parâmetro será ignorado.
Tag	dictionary		Lista de tags do Amazon EFS. Deve ser definido como dicionário.
targets	list/elements=string		Lista de destinos nos quais filtrar os resultados retornados. O resultado deve corresponder a todos os destinos especificados, cada um dos quais pode ser um ID de grupo de segurança, um ID de sub-rede ou um endereço IP.
valid_certs	boolean	Escolhas: false true ← (padrão)	Quando definido como “false”, os certificados SSL não serão validados para comunicação com as APIs da AWS.

Notas

Observação

Se os parâmetros não forem definidos no módulo, as seguintes variáveis de ambiente podem ser usadas em ordem decrescente de precedência
- AWS_URL ou EC2_URL, AWS_PROFILE ou AWS_DEFAULT_PROFILE,
- AWS_ACCESS_KEY_ID ou AWS_ACCESS_KEY ou EC2_ACCESS_KEY,
- AWS_SECRET_ACCESS_KEY ou AWS_SECRET_KEY ou EC2_SECRET_KEY,
- AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN,
- AWS_REGION ou EC2_REGION,
- AWS_CA_BUNDLE
Quando nenhuma credencial é fornecida explicitamente, o AWS SDK (boto3) que o Ansible usa retornará aos seus arquivos de configuração (normalmente ~/.aws/credentials). Consulte https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html para obter mais informações.
Módulos baseados no AWS SDK original (boto) podem ler sua configuração padrão de arquivos diferentes. Consulte https://boto.readthedocs.io/en/latest/boto_config_tut.html para obter mais informações.
AWS_REGION ou EC2_REGION pode ser normalmente usado para especificar a região da AWS, quando necessário, mas isso também pode ser definido nos arquivos de configuração.

Exemplos

- name: Find all existing efs
  efs_info:
  register: result

- name: Find efs using id
  efs_info:
    id: fs-1234abcd
  register: result

- name: Searching all EFS instances with tag Name = 'myTestNameTag', in subnet 'subnet-1a2b3c4d' and with security group 'sg-4d3c2b1a'
  efs_info:
    tags:
        Name: myTestNameTag
    targets:
        - subnet-1a2b3c4d
        - sg-4d3c2b1a
  register: result

- debug:
    msg: "{{ result['efs'] }}"

Valores de retorno

Chave	Tipo	Retornado quando	Descrição
hora_de_criação	string	sempre	timestamp da data de criação
criação_token	string	sempre	Token de criação do EFS
file_system_id	string	sempre	ID do sistema de arquivos
filesystem_address	string	sempre	url do sistema de arquivos
life_cycle_state	string	sempre	estado do sistema de arquivos EFS
ponto de montagem	string	sempre	URL do sistema de arquivos com ponto inicial do momento em que o AWS EFS é necessário para adicionar o sufixo de rede ao endereço do EFS
mount_targets	list / elements=string	sempre	lista de destinos de montagem
nome	string	sempre	nome do sistema de arquivos
number_of_mount_targets	integer	sempre	o número de alvos montados
proprietário_id	string	sempre	ID da conta da AWS do proprietário do EFS
modo de desempenho	string	sempre	modo de desempenho do sistema de arquivos
provisioned_throughput_in_mibps	float	quando throughput_mode é definido como “provisionado”	taxa de transferência provisionada em Mibps
size_in_bytes	dictionary	sempre	tamanho do sistema de arquivos em bytes a partir de um carimbo de data/hora
Tag	dictionary	sempre	tags na instância efs
throughput_mode	string	sempre	modo de taxa de transferência para o sistema de arquivos