Comandos de la interfaz de línea de comandos para Omnissa Access

Una vez completada la implementación de Omnissa Access, utilice la interfaz de línea de comandos (CLI) para gestionar y mantener su entorno.

La CLI permite realizar tareas administrativas cotidianas, como validar la configuración, inicializar y actualizar los ajustes de los inquilinos, rotar certificados, comprobar la disponibilidad del servicio, ejecutar comprobaciones de estado, recopilar registros, restaurar copias de seguridad, actualizar paquetes del sistema operativo y gestionar servicios en Omnissa Access Control Plane.

Los comandos se organizan en grupos según el área administrativa:

• wso access: Gestiona los inquilinos de Omnissa Access y la configuración SMTP.
• wso control-plane: Implementa, valida, actualiza, restaura y mantiene los componentes de Omnissa Access Control Plane.
• wso services: Implementa, restaura, realiza instantáneas y gestiona las operaciones a nivel de servicio.
• wso healthcheck, wso validate-log-config y los comandos relacionados verifican el estado de la implementación y la configuración.

En la siguiente tabla se indican los comandos de la CLI disponibles, junto con una breve descripción de cada uno.

Comandos wso

• wso

  Comando raíz de la CLI de Omnissa Access. Ejecuta wso --help para mostrar todos los comandos disponibles y su uso.

• source <(wso completion bash): Activa la función de autocompletado en la sesión actual del terminal. Debe ejecutar el comando source <(wso completion bash) cada vez que inicie una nueva sesión del terminal.

• wso access

  Gestiona la instalación y la configuración de Omnissa Access.

  wso access add-tenant-admin-users: Agrega un usuario administrador a un inquilino de Access.

  wso access bootstrap: Carga el perfil de Access, valida los certificados, genera variables de entorno y sincroniza los datos clave-valor y los secretos.

  wso access check-service-readiness: Comprueba si los servicios de Access están listos.

  wso access configure-cert-proxy: Configura cert-proxy para el clúster de Access.

  wso access create-admin-client: Crea un cliente OAuth2 de administración en un inquilino.

  wso access create-tenant: Crea el primer inquilino de Access.

  wso access init: Inicializa el directorio de trabajo para la instalación de Omnissa Access.

  wso access push-notifications: Comando para gestionar las notificaciones push en Hub Services.

  wso access rate-limit set: Establece límites de tasa para Omnissa Access, con los siguientes indicadores:

  • --login_rpm: Límite de frecuencia para las solicitudes de inicio de sesión
  • --launch_rpm: Límite de frecuencia para las solicitudes de inicio
  • --wsfed_rpm: Límite de frecuencia para las solicitudes WS-Fed
  • --tenant_id: Identificador del inquilino; solo se solicita en implementaciones multiinquilino

  wso access rate-limit get: Obtiene la configuración actual del límite de velocidad para Omnissa Access.

  wso access reset-admin-password: Restablece la contraseña de un usuario administrador del inquilino.

  wso access rotate-certificate: Rota los certificados de Access (FQDN o cert-proxy).

  wso access SMTP: Inicializa, obtiene, valida y actualiza la configuración de SMTP.

  wso access smtp get: Obtiene los parámetros SMTP para enviar correo utilizando un servidor SMTP.
  wso access smtp init: Inicializa SMTP para enviar correo.
  wso access smtp update: Actualiza los parámetros SMTP para enviar correo utilizando un servidor SMTP.
  wso access smtp validate: Valida los parámetros SMTP para enviar correo utilizando un servidor SMTP.

  wso access update-config: Sincroniza la configuración de Consul KV y Vault de la plataforma Access durante la actualización.

  wso access validate: Valida el archivo de inventario del clúster de Access y los requisitos.

• wso configure

  Configura la CLI para que utilice una versión específica de los componentes de Omnissa Access.

• wso control-plane

  Implementa y gestiona los componentes de Omnissa Access Control Plane. Utilice wso cp como alias abreviado para este comando.

  wso control-plane ansible: Ejecuta comandos arbitrarios de Ansible en el clúster del plano de control.

  wso control-plane collect-log-bundle: Recopila los registros fuera de línea de los nodos del clúster en un paquete.

  wso control-plane deploy: Implementa los componentes de Omnissa Access Control Plane.

  wso control-plane diagnostics: Ejecuta pruebas de diagnóstico en los nodos de Omnissa Access Control Plane.

  wso control-plane hydrate-assets: Agrega los activos más recientes.

  wso control-plane plan-restore-backup: Planifica la restauración de la configuración y los datos clave-valor desde la copia de seguridad al Omnissa Control Plane.

  wso control-plane precheck: Verifica si la configuración del clúster cumple los requisitos de implementación.

  wso control-plane reset-assets: Elimina los activos antiguos y restablece los activos más recientes.

  wso control-plane restart-schedulers: Reinicia los agentes programadores de servicios en el clúster de Omnissa Access Control Plane.

  wso control-plane restore-backup: Restaura la configuración y los datos clave-valor desde la copia de seguridad a Omnissa Access Control Plane.

  wso control-plane sync-time: Sincroniza la hora en las máquinas virtuales de Omnissa Access Control Plane.

  wso control-plane unseal: Desbloquea los nodos de Vault en Omnissa Access Control Plane.

  wso control-plane update-agents: Actualiza las versiones de los agentes o la configuración de los componentes de Omnissa Access Control Plane en las máquinas virtuales de los agentes.

  wso control-plane update-certificate: Actualiza los certificados de los servicios de Omnissa Access Control Plane.

  wso control-plane update-os: Actualiza los paquetes en cada nodo Linux de Omnissa Access Control Plane.

  wso control-plane update-telemetry: Actualiza la telemetría en cada nodo de Omnissa Access Control Plane.

• wso cp

  Alias del comando wso control-plane. Admite los mismos subcomandos.

• wso eula

  Muestra el acuerdo de licencia de usuario final (EULA) y permite aceptarlo o rechazarlo.

• wso healthcheck

  Realiza una comprobación básica del estado del plano de control, incluidos los componentes principales de la plataforma y los servicios que se ejecutan sobre ella.

• wso services

  Implementa y administra servicios en Omnissa Control Plane.

  wso services config-report: Muestra las configuraciones y las modificaciones en uso.

  wso services deploy: Implementa servicios en Omnissa Control Plane.

  wso services list: Muestra la configuración de un servicio determinado.

  wso services restore: Restaura servicios en Omnissa Control Plane.

  wso services set-log-level: Establece el nivel de registro de un servicio determinado.

  wso services snapshot: Realiza una instantánea de los servicios en Omnissa Access Control Plane.

  wso services sync-kv: Sincroniza con el almacén de clave-valor desde un directorio del sistema de archivos local.

  wso services sync-secrets: Sincroniza con el almacén de secretos desde un directorio del sistema de archivos local.

  wso services temp-creds-generate: Genera credenciales temporales para un servicio.

  wso services temp-creds-revoke: Revoca las credenciales temporales de un servicio.

• wso validate-log-config

  Valida la configuración del registro (syslog, Loki, OpenSearch) y comprueba la disponibilidad.

• wso version

  Muestra la versión de la CLI.

Tareas administrativas habituales

Los siguientes ejemplos muestran cómo utilizar los comandos de la interfaz de línea de comandos (CLI) más habituales tras la implementación.

Generar un paquete de registros

Utilice wso control-plane collect-log-bundle para recopilar los registros sin conexión de todos los nodos del clúster en un único paquete para solucionar problemas. De forma predeterminada, este comando busca el archivo de inventario del clúster en el directorio actual; indique un directorio de trabajo como argumento para ejecutarlo desde otra ubicación.

wso cp collect-log-bundle

Los registros se guardan en /tmp/.

Restablecer la contraseña de administrador del inquilino

De forma predeterminada, envía un correo electrónico de restablecimiento de contraseña al usuario; utilice --send_mail=false para omitirlo. El valor predeterminado del dominio es System Domain, a menos que se especifique --domain.

wso access reset-admin-password

Crear el primer inquilino de Access

wso access create-tenant

Desbloquear nodos de Vault

Utilice wso control-plane unseal si Vault queda bloqueado tras una operación de mantenimiento, como el reinicio de un nodo. De forma predeterminada, este comando busca el archivo de inventario del plano de control en el directorio actual; indique un directorio de trabajo como argumento para ejecutarlo desde otra ubicación.

wso cp unseal

Ejecutar diagnósticos

Utilice wso control-plane diagnostics para ejecutar diagnósticos en los nodos del plano de control.

wso cp diagnostics

Restaurar la configuración desde una copia de seguridad

Utilice wso control-plane restore-backup para restaurar la configuración y los datos de clave-valor en el plano de control. Para ello, es necesario disponer de un plan de restauración que ya se haya creado y verificado mediante plan-restore-backup. De forma predeterminada, este comando busca el archivo de inventario del plano de control en el directorio actual; indique un directorio de trabajo como argumento para ejecutarlo desde otra ubicación.

wso cp restore-backup

Comprobar el estado de disponibilidad del servicio

Utilice wso access check-service-readiness para comprobar que los servicios de Access están disponibles. Compruebe todos los servicios o uno concreto por su nombre.

wso access check-service-readiness
wso access check-service-readiness --service_name saas

Crear un cliente OAuth2 de administración

Utilice wso access create-admin-client para crear un cliente OAuth2 con ámbito de administración en un inquilino con el fin de autenticarse en la API de ACS. Ejecute este comando tras la creación del inquilino. El secreto del cliente solo se muestra una vez, por lo que debe guardarlo de forma segura.

wso access create-admin-client --tenant_id my-tenant --client_id my-admin-client

Ejecutar una comprobación de estado

Utilice wso healthcheck para ejecutar una comprobación básica del estado del plano de control, incluidos los componentes principales de la plataforma y los servicios que se ejecutan sobre ella. El resultado se muestra por defecto con el formato table; utilice -f json para obtener un resultado legible por máquina.

wso healthcheck

Agregue -n/--include_node_stats para incluir estadísticas de nodo en el resultado (esto aumenta el tiempo de ejecución).

Agregar un usuario administrador de un inquilino

Utilice wso access add-tenant-admin-users para agregar un usuario administrador a un inquilino existente.

wso access add-tenant-admin-users --tenant_name my-tenant --admin_username admin --admin_email admin@example.com

Configurar SMTP

Utilice los comandos wso access smtp para inicializar, recuperar, validar y actualizar la configuración SMTP del correo saliente.

wso access smtp init
wso access smtp update --SMTP_HOST smtp.example.com --SMTP_PORT 587 --SMTP_USER user --SMTP_PASSWORD ****** --SMTP_SECURITY_TYPE TLS
wso access smtp get
wso access smtp validate

Establecer límites de velocidad

Utilice wso access rate-limit set para establecer el número máximo de solicitudes de inicio de sesión, de ejecución y de WS-Fed permitidas por minuto. Utilice wso access rate-limit get para ver los límites actuales.

wso access rate-limit set --tenant_id my-tenant --login_rpm 100 --launch_rpm 100 --wsfed_rpm 100
wso access rate-limit get --tenant_id my-tenant

Rotar un certificado

Utilice wso access rotate-certificate para rotar el certificado FQDN o el certificado de Cert-Proxy. Indique únicamente los nombres de los archivos del certificado y de la clave (no una ruta), tal y como aparecen en /root/<cluster_name>/access/certs.

wso access rotate-certificate --cert_type fqdn --cert_file cert.pem --key_file key.pem

Configurar Cert-Proxy

Utilice wso access configure-cert-proxy para configurar Cert-Proxy como una operación de día 2 en una implementación existente de Access. Los parámetros --ssl_certificate_path y --ssl_certificate_key solo son obligatorios cuando --ssl_certificate_type es CUSTOM_CERT; no son necesarios para FQDN_CERT.

wso access configure-cert-proxy --ssl_certificate_type CUSTOM_CERT --ssl_certificate_path cert.pem --ssl_certificate_key key.pem

Establecer un nivel de registro del servicio

Utilice wso services set-log-level para cambiar el nivel de registro de un servicio determinado. De forma predeterminada, esta orden busca la configuración en el directorio actual; pase un directorio de trabajo como argumento para ejecutarla desde otra ubicación. Si no se especifica --log-level, se utilizará el nivel de registro predeterminado del propio servicio.

wso services set-log-level --service <service-name> --log-level debug

Validar la configuración de registro

Utilice wso validate-log-config para validar la configuración de registro (syslog, Loki, OpenSearch) y comprobar la accesibilidad.

wso validate-log-config