Comandos de interface de linha de comando para o Omnissa Access

Após uma implantação bem-sucedida do Omnissa Access, use a interface de linha de comando (CLI) para gerenciar e manter seu ambiente.

A CLI oferece suporte a tarefas administrativas do dia a dia, incluindo a validação da configuração, a inicialização e atualização das configurações do locatário, a rotação de certificados, a verificação da disponibilidade do serviço, a execução de verificações de integridade, a coleta de logs, a restauração de backups, a atualização de pacotes do sistema operacional e o gerenciamento de serviços no Omnissa Access Control Plane.

Os comandos estão organizados em grupos por área administrativa:

• wso access — Gerenciar locatários do Omnissa Access e a configuração SMTP.
• wso control-plane — Implantar, validar, atualizar, restaurar e manter os componentes do Omnissa Access Control Plane.
• wso services — Implantar, restaurar, criar snapshots e gerenciar operações no nível do serviço.
• wso healthcheck, wso validate-log-config e comandos relacionados verificam a integridade da implantação e a configuração.

A tabela a seguir lista os comandos da CLI disponíveis com uma breve descrição de cada um.

Comandos wso

• wso

  Comando raiz da CLI do Omnissa Access. Execute wso --help para exibir todos os comandos disponíveis e seu uso.

• source <(wso completion bash): ativa o preenchimento automático na sessão atual do terminal. Você deve executar o comando source <(wso completion bash) sempre que iniciar uma nova sessão de terminal.

• wso access

  Gerencia a instalação e a configuração do Omnissa Access.

  wso access add-tenant-admin-users: adiciona um usuário administrador a um locatário do Access.

  wso access bootstrap: carrega o perfil do Access, valida certificados, gera variáveis de ambiente e sincroniza dados de chave-valor e segredos.

  wso access check-service-readiness: verifica a prontidão dos serviços do Access.

  wso access configure-cert-proxy: configura o cert-proxy para o cluster do Access

  wso access create-admin-client: cria um cliente administrador OAuth2 em um locatário

  wso access create-tenant: cria o primeiro locatário do Access.

  wso access init: inicializa o diretório de trabalho para a instalação do Omnissa Access.

  wso access push-notifications: comando para gerenciar notificações push no Hub Services.

  wso access rate-limit set: define limites de taxa para o Omnissa Access, com os seguintes sinalizadores:

  • --login_rpm - limite de taxa para solicitações de login
  • --launch_rpm - limite de taxa para solicitações de inicialização
  • --wsfed_rpm - limite de taxa para solicitações WS-Fed
  • --tenant_id - identificador do locatário; solicitado apenas em implantações multilocatárias

  wso access rate-limit get: obtém as configurações atuais de limite de taxa para o Omnissa Access.

  wso access reset-admin-password: redefine a senha de um usuário administrador do locatário.

  wso access rotate-certificate: realiza a rotação de certificados do Access (FQDN ou cert-proxy).

  wso access smtp: inicializa, obtém, valida e atualiza a configuração SMTP.

  wso access smtp get: obtém os parâmetros SMTP para o envio de e-mails usando um servidor SMTP.
  wso access smtp init: inicializa o SMTP para o envio de e-mails.
  wso access smtp update: atualiza os parâmetros SMTP para o envio de e-mails usando um servidor SMTP.
  wso access smtp validate: valida os parâmetros SMTP para o envio de e-mails usando um servidor SMTP.

  wso access update-config: reconcilia as configurações do Consul KV e do Vault da plataforma Access durante o upgrade

  wso access validate: valida o arquivo de inventário do cluster do Access e os pré-requisitos.

• wso configure

  Configura a CLI para usar uma versão específica dos componentes do Omnissa Access.

• wso control-plane

  Implanta e gerencia os componentes do Omnissa Access Control Plane. Use wso cp como um alias abreviado para este comando.

  wso control-plane ansible: executa comandos arbitrários do Ansible no cluster do Control Plane.

  wso control-plane collect-log-bundle: coleta logs offline dos nós do cluster em um pacote.

  wso control-plane deploy: implanta componentes do Omnissa Access Control Plane.

  wso control-plane diagnostics: executa diagnósticos nos nós do Omnissa Access Control Plane.

  wso control-plane hydrate-assets: adiciona os ativos mais recentes.

  wso control-plane plan-restore-backup: planeja a restauração da configuração e dos dados de chave-valor do backup para o Omnissa Control Plane.

  wso control-plane precheck: verifica se a configuração do cluster atende aos requisitos de implantação.

  wso control-plane reset-assets: limpa ativos antigos e redefine para os ativos mais recentes.

  wso control-plane restart-schedulers: reinicia os agentes agendadores de serviço no cluster do Omnissa Access.

  wso control-plane restore-backup: restaura a configuração e os dados de chave-valor do backup para o Omnissa Access Control Plane.

  wso control-plane sync-time: sincroniza a hora nas máquinas virtuais do Omnissa Access Control Plane.

  wso control-plane unseal: desbloqueia os nós do Vault no Omnissa Access Control Plane.

  wso control-plane update-agents: faz upgrade das versões dos agentes ou da configuração dos componentes do Omnissa Access Control Plane nas máquinas virtuais dos agentes.

  wso control-plane update-certificate: atualiza os certificados dos serviços do Omnissa Access Control Plane.

  wso control-plane update-os: atualiza pacotes em cada nó Linux do Omnissa Access Control Plane.

  wso control-plane update-telemetry: atualiza a telemetria em cada nó do Omnissa Access Control Plane.

• wso cp

  Alias para o comando wso control-plane. Aceita todos os mesmos subcomandos.

• wso eula

  Exibe o EULA e permite aceitar ou rejeitar.

• wso healthcheck

  Executa uma verificação básica de integridade no Control Plane, incluindo componentes centrais da plataforma e serviços em execução nela.

• wso services

  Implanta e gerencia serviços no Omnissa Control Plane.

  wso services config-report: relata as configurações e substituições em uso.

  wso services deploy: implanta serviços no Omnissa Control Plane.

  wso services list: exibe as configurações de um determinado serviço.

  wso services restore: restaura serviços no Omnissa Control Plane.

  wso services set-log-level: define o nível de log para um determinado serviço.

  wso services snapshot: cria um snapshot dos serviços no Omnissa Access Control Plane.

  wso services sync-kv: sincroniza com o armazenamento de chave-valor de um diretório do sistema de arquivos local.

  wso services sync-secrets: sincroniza com o armazenamento de segredos de um diretório do sistema de arquivos local.

  wso services temp-creds-generate: gera credenciais temporárias para um serviço.

  wso services temp-creds-revoke: revoga credenciais temporárias para um serviço.

• wso validate-log-config

  Valida a configuração de registro (syslog, Loki, OpenSearch) e verifica a acessibilidade.

• wso version

  Exibe a versão da CLI.

Tarefas administrativas comuns

Os exemplos a seguir mostram como usar comandos da CLI frequentemente necessários após a implantação.

Gerar um pacote de logs

Use wso control-plane collect-log-bundle para coletar logs offline de todos os nós do cluster em um único pacote para fins de solução de problemas. Por padrão, isso verifica o diretório atual em busca do arquivo de inventário do cluster; passe um diretório de trabalho como argumento para executá-lo de outro local.

wso cp collect-log-bundle

Os logs são salvos em /tmp/.

Redefinir senha de administrador do locatário

Envia um e-mail de redefinição de senha ao usuário por padrão; use --send_mail=false para ignorar essa etapa. O domínio padrão é System Domain, a menos que --domain seja especificado.

wso access reset-admin-password

Criar o primeiro locatário de acesso

wso access create-tenant

Desbloquear nós do Vault

Use wso control-plane unseal se o Vault ficar bloqueado após uma operação de manutenção, como a reinicialização de um nó. Por padrão, isso verifica o diretório atual em busca do arquivo de inventário do Control Plane; passe um diretório de trabalho como argumento para executá-lo de outro local.

wso cp unseal

Executar diagnósticos

Use wso control-plane diagnostics para executar diagnósticos nos nós do Control Plane.

wso cp diagnostics

Restaurar configuração do backup

Use wso control-plane restore-backup para restaurar a configuração e os dados de chave-valor no Control Plane. Isso requer um plano de restauração que já tenha sido criado e verificado usando plan-restore-backup. Por padrão, isso verifica o diretório atual em busca do arquivo de inventário do Control Plane; passe um diretório de trabalho como argumento para executá-lo de outro local.

wso cp restore-backup

Verificar a prontidão do serviço

Use wso access check-service-readiness para verificar se os serviços do Access estão prontos. Verifique todos os serviços ou um específico pelo nome.

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

Criar um cliente OAuth2 administrador

Use wso access create-admin-client para criar um cliente OAuth2 com escopo de administrador em um locatário, para autenticação na API do ACS. Execute isso após a criação do locatário. O segredo do cliente é exibido apenas uma vez; portanto, armazene-o com segurança.

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

Executar uma verificação de integridade

Use wso healthcheck para executar uma verificação de integridade básica no Control Plane, incluindo os componentes principais da plataforma e os serviços em execução nela. A saída é padronizada no formato table; use -f json para obter uma saída legível por máquina.

wso healthcheck

Adicione -n/--include_node_stats para incluir estatísticas do nó na saída (isso aumenta o tempo de execução).

Adicionar um usuário administrador de locatário

Use wso access add-tenant-admin-users para adicionar um usuário administrador a um locatário existente.

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

Configurar o SMTP

Use os comandos wso access smtp para inicializar, obter, validar e atualizar as configurações do SMTP para e-mails enviados.

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

Definir limites de taxa

Use wso access rate-limit set para definir o número máximo de solicitações de login, inicialização e WS-Fed permitidas por minuto. Use wso access rate-limit get para visualizar os limites atuais.

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

Alternar um certificado

Use wso access rotate-certificate para alternar o certificado FQDN ou do cert-proxy. Forneça apenas os nomes dos arquivos do certificado e da chave (não um caminho), conforme encontrado em /root/<cluster_name>/access/certs.

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

Configurar o cert-proxy

Use wso access configure-cert-proxy para configurar o cert-proxy como uma operação de Dia 2 em uma implantação existente do Access. --ssl_certificate_path e --ssl_certificate_key são necessários apenas quando --ssl_certificate_type for CUSTOM_CERT; eles não são necessários para FQDN_CERT.

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

Definir um nível de log de serviço

Use wso services set-log-level para alterar o nível de log de um determinado serviço. Por padrão, isso verifica o diretório atual em busca da configuração; passe um diretório de trabalho como argumento para executá-lo de outro local. Se --log-level não for especificado, o nível de log padrão do próprio serviço será usado.

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

Validar a configuração de log

Use wso validate-log-config para validar a configuração de log (syslog, Loki, OpenSearch) e verificar a acessibilidade.

wso validate-log-config