informatiquecdc.win_authorized_key

Descripción general Versiones Perspectivas

win_authorized_key - Añade o elimina una clave SSH autorizada

Sinopsis

Módulo de Ansible para agregar o eliminar claves SSH autorizadas para cuentas de usuario específicas en sistemas basados en Windows.

Requisitos

Los siguientes requisitos son necesarios en el host que ejecuta este módulo.

Win32 OpenSSH

Parámetros

Parámetro	Opciones/Predeterminados	Comentarios
usuario cadena / requerido		El nombre de usuario en el host remoto cuyo archivo authorized_keys será modificado
clave cadena / requerido		La(s) clave(s) pública(s) SSH, como una cadena o (desde la 1.9) url https://github.com/username.keys
ruta cadena	Predeterminado: (homedir)+/.ssh/authorized_keys	Ruta alternativa al archivo authorized_keys
gestionar_dir booleano	Opciones: no sí ←	Si este módulo debe gestionar el directorio del archivo de clave autorizada. Si se establece, el módulo creará el directorio, así como también establecerá el propietario y los permisos de un directorio existente. Asegúrate de establecer gestionar_dir=`no` si estás usando un directorio alternativo para authorized_keys, como se establece con `ruta`, ya que podrías bloquearte fuera del acceso SSH. Consulta el ejemplo a continuación.
estado cadena	Opciones: presente ← ausente	Si la clave dada (con las opciones de clave dadas) debería o no estar en el archivo
opciones_clave cadena		Una cadena de opciones de clave SSH que se agregarán al principio de la clave en el archivo authorized_keys
exclusivo booleano	Opciones: no ← sí	Si se deben eliminar todas las demás claves no especificadas del archivo authorized_keys. Se pueden especificar múltiples claves en un solo valor de cadena clave separándolas por nuevas líneas. Esta opción no es consciente del bucle, por lo que si usas `con_`, será exclusivo por iteración del bucle; si deseas múltiples claves en el archivo, necesitas pasarlas todas a `clave` en un solo lote, como se mencionó arriba.
validar_certs booleano	Opciones: no sí ←	Esto solo se aplica si usas una url https como fuente de las claves. Si se establece en `no`, los certificados SSL no serán validados. Esto solo debe establecerse en `no` en sitios controlados personalmente que utilizan certificados autofirmados, ya que evita verificar el sitio de origen.
comentario cadena		Cambia el comentario en la clave pública. Reescribir el comentario es útil en casos como obtenerlo de GitHub o GitLab. Si no se especifica ningún comentario, se mantendrá el comentario existente.
seguir booleano	Opciones: no ← sí	Seguir un enlace simbólico de ruta en lugar de reemplazarlo

Ejemplos

---
roles:
  - win_authorized_key

tasks:

  - name: Establecer clave autorizada tomada de un archivo
    win_authorized_key:
      usuario: charlie
      estado: presente
      clave: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"

  - name: Establecer claves autorizadas tomadas de una URL
    win_authorized_key:
      usuario: charlie
      estado: presente
      clave: https://github.com/charlie.keys

  - name: Establecer clave autorizada en una ubicación alternativa
    win_authorized_key:
      usuario: charlie
      estado: presente
      clave: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
      ruta: c:/ProgramData/ssh/administrators_authorized_key
      gestionar_dir: False

  - name: Configurar múltiples claves autorizadas
    win_authorized_key:
      usuario: deploy
      estado: presente
      clave: '{{ item }}'
    con_archivo:
      - public_keys/doe-jane
      - public_keys/doe-john

  - name: Establecer clave autorizada definiendo opciones de clave
    win_authorized_key:
      usuario: charlie
      estado: presente
      clave: "{{ lookup('file', 'c:/users/charlie/.ssh/id_rsa.pub') }}"
      opciones_clave: 'no-port-forwarding,from="10.0.1.1"'

  - name: Establecer clave autorizada sin validar los certificados TLS/SSL
    win_authorized_key:
      usuario: charlie
      estado: presente
      clave: https://github.com/user.keys
      validar_certs: False

  - name: Establecer clave autorizada, eliminando todas las claves autorizadas ya configuradas
    win_authorized_key:
      usuario: administrador
      clave: '{{ item }}'
      estado: presente
      exclusivo: True
    con_archivo:
      - public_keys/doe-jane

Valores de Retorno

Los valores de retorno comunes están documentados aquí, los siguientes son los campos únicos para este módulo:

Clave	Devuelto	Descripción
exclusivo booleano	éxito	Si la clave ha sido forzada a ser exclusiva o no. Ejemplo: False
clave cadena	éxito	La clave contra la que se estaba ejecutando el módulo. Ejemplo: https://github.com/user.keys
opción_clave cadena	éxito	Opciones de clave relacionadas con la clave.
archivo_clave cadena	éxito	Ruta para el archivo de clave autorizada. Ejemplo: C:/users/charlie/.ssh/authorized_keys
gestionar_dir booleano	éxito	Si este módulo gestionó el directorio del archivo de clave autorizada. Ejemplo: True
ruta cadena	éxito	Ruta alternativa al archivo authorized_keys.
estado cadena	éxito	Si se debe o no estar la clave dada (con las opciones de clave dadas) en el archivo. Ejemplo: presente
único booleano	éxito	Si la clave es única. Ejemplo: False
usuario cadena	éxito	El nombre de usuario en el host remoto cuyo archivo authorized_keys será modificado. Ejemplo: usuario
validar_certs booleano	éxito	Esto solo se aplica si se usa una url https como fuente de las claves. Si se establece en `no`, los certificados SSL no serán validados. Ejemplo: True