Nota

Este complemento es parte del colección ansible.windows (versión 1.3.0).

Para instalarlo use: ansible-galaxy collection install ansible.windows.

Para usarlo en un libro de jugadas, especifique: ansible.windows.win_regedit.

  • Sinopsis
  • Parámetros
  • Notas
  • Ver también
  • Ejemplos de
  • Valores devueltos

Sinopsis

Parámetros

Parámetro Opciones / Valores predeterminados Comentarios
datoscrudo Valor de la entrada de registro name en path.Si no se especifica, el valor de la propiedad será null para el correspondiente typeLos datos binarios y ninguno deben expresarse en un byte yaml. array o como valores hexadecimales separados por comas. Una forma fácil de generar esto es ejecutar regedit.exe y usa el exportar opción para guardar los valores del registro en un archivo. En el archivo exportado, el valor binario se verá como hex:be,ef,be,ef, los hex: prefix es opcional. Los valores DWORD y QWORD deben representarse como un número decimal o un valor hexadecimal. Los valores de cadenas múltiples deben pasarse como una lista. Consulte los ejemplos para obtener más detalles sobre cómo formatear estos datos.
delete_keybooleano
    Opciones:

  • no
Cuando state está ‘ausente’, entonces esto eliminará todo key.Si no entonces solo borrará la propiedad ‘(Predeterminado)’ para eso key.
colmenasendero Un camino a una colmena key como C: Users Default NTUSER.DAT para cargar en el registro. Esta colmena se carga bajo el HKLM: ANSIBLE key que luego se puede utilizar en nombre como cualquier otra ruta.Esto se puede usar para cargar el subárbol de registro de perfil de usuario predeterminado o cualquier otro subárbol guardado como un archivo.Usar esta función requiere que el usuario tenga la SeRestorePrivilege y SeBackupPrivilege privilegios habilitados.
nombrestring Nombre de la entrada de registro en lo anterior path Si no se proporciona, o está vacía, entonces la propiedad ‘(Predeterminado)’ para el key se utilizará.
alias: entrada, valor
senderostring / requerido Nombre de la ruta del registro. Debe estar en una de las siguientes secciones del registro: HKCC, HKCR, HKCU, HKLM, HKU.
alias: key
estadostring
    Opciones:

  • ausente
  • regalo
El estado de la entrada de registro.
escribestring
    Opciones:

  • ninguno
  • binario
  • dword
  • expandstring
  • multicadena
  • string
  • qword
El tipo de datos del valor de registro.
alias: tipo de datos

Notas

Nota

  • Modo de verificación -C/--check y salida diferencial -D/--diff son compatibles, de modo que pueda probar cada cambio con la configuración activa antes de aplicar los cambios.
  • Tenga en cuenta que algunas colmenas de registro (HKEY_USERS en particular) no permiten crear nuevas rutas de registro en la carpeta raíz.

Ver también

Ver también

ansible.windows.win_reg_stat

La documentación oficial sobre el ansible.windows.win_reg_stat módulo.

ansible.windows.win_regmerge

La documentación oficial sobre el ansible.windows.win_regmerge módulo.

Ejemplos de

-name: Create registry path MyCompany
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany

-name: Add or update registry path MyCompany, with entry 'hello', and containing 'world'
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    data: world

-name: Add or update registry path MyCompany, with dword entry 'hello', and containing 1337 as the decimal value
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    data:1337type: dword

-name: Add or update registry path MyCompany, with dword entry 'hello', and containing 0xff2500ae as the hex value
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    data:0xff2500aetype: dword

-name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in hex-string format
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    data: hex:be,ef,be,ef,be,ef,be,ef,be,ef
    type: binary

-name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in yaml format
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    data:[0xbe,0xef,0xbe,0xef,0xbe,0xef,0xbe,0xef,0xbe,0xef]type: binary

-name: Add or update registry path MyCompany, with expand string entry 'hello'
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    data:'%appdata%local'type: expandstring

-name: Add or update registry path MyCompany, with multi string entry 'hello'
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    data:['hello','world']type: multistring

-name: Disable keyboard layout hotkey for all users (changes existing)
  ansible.windows.win_regedit:path: HKU:.DEFAULTKeyboard LayoutToggle
    name: Layout Hotkey
    data:3type: dword

-name: Disable language hotkey for current users (adds new)
  ansible.windows.win_regedit:path: HKCU:Keyboard LayoutToggle
    name: Language Hotkey
    data:3type: dword

-name: Remove registry path MyCompany (including all entries it contains)
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    state: absent
    delete_key: yes

-name: Clear the existing (Default) entry at path MyCompany
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    state: absent
    delete_key: no

-name: Remove entry 'hello' from registry path MyCompany
  ansible.windows.win_regedit:path: HKCU:SoftwareMyCompany
    name: hello
    state: absent

-name: Change default mouse trailing settings for new users
  ansible.windows.win_regedit:path: HKLM:ANSIBLEControl PanelMouse
    name: MouseTrails
    data:10type: str
    state: present
    hive: C:UsersDefaultNTUSER.dat

Valores devueltos

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

Llave Devuelto Descripción
datos_cambiadosbooleano éxito Si esta invocación cambió los datos en el valor del registro.
data_type_changedbooleano éxito Si esta invocación cambió el tipo de datos del valor de registro.
Muestra:Cierto

Autores

  • Adam Keech (@ smadam813)
  • Josh Ludwig (@joshludwig)
  • Jordan Borean (@ jborean93)