Github Key
Resumo
- Cria, remove ou atualiza as chaves de acesso do GitHub.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
força | boolean | Escolhas: - false - true (default) | O padrão é true, que substituirá a chave remota existente se for diferente de pubkey. Se false, a chave só será definida se nenhuma chave com o dado name existir. |
name - required | string | | Nome da chave SSH |
pubkey | string | | Valor da chave pública SSH. Obrigatório quando state=present. |
state | string | Escolhas: - present (default) - absent | Se deseja remover uma chave, garantir que ela exista ou atualizar seu valor. |
token - required | string | | Token de acesso do GitHub com permissão para listar e criar chaves públicas. |
Exemplos
# Read SSH public key to authorize
ansible.builtin.shell: cat /home/foo/.ssh/id_rsa.pub
register: ssh_pub_key
# Authorize key with GitHub
local_action:
module: github_key
name: Access Key for Some Machine
token: '{{ github_access_token }}'
pubkey: '{{ ssh_pub_key.stdout }}'
Valores Retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
deleted_keys | list / elements=string | state=absent | Uma matriz de objetos principais que foram excluídos. Apenas presente no state=absent |
key | dictionary | sucesso | Metadados sobre a chave recém-criada. Apenas presente no state=absent |
matching_keys | list / elements=string | state=absent | Uma matriz de chaves que correspondem ao nome especificado. Apenas presente no state=absent |