Referência da CLI para comandos do Satellite

Consulte estes comandos da CLI do Satellite quando desejar automatizar a criação e o gerenciamento do seu ambiente do Satellite, incluindo operações relacionadas a localização, host, cluster e endpoint.

Para instalar a CLI, consulte Instalando a CLI Para visualizar um mapa de alto nível de todos os comandos do site IBM Cloud Satellite, consulte o mapa da CLI.

  1. Instale a CLI do IBM Cloud. Consulte Introdução ao IBM Cloud CLI.

  2. Instale o plug-in “ ks ”.

    ibmcloud plugin install ks
    

Comandos do Acl

Visualizar e gerenciar listas de controle de acesso (ACLs) d Satellite.

ibmcloud sat acl create

Satellite

Crie uma ACL.

ibmcloud sat acl create --name NAME --subnet SUBNET [--subnet SUBNET ...] [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Um nome ou ID de um ponto de extremidade a ser ativado para essa ACL.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--name
O nome da ACL.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--subnet
Um bloco IP ou CIDR permitido por essa ACL. O valor deve estar totalmente contido nos seguintes CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Exemplos

Criar uma ACL

ibmcloud sat acl create --name NAME --subnet SUBNET --connector-id ID

ibmcloud sat acl endpoint add

Satellite

Adicione um ou mais pontos de extremidade habilitados a uma ACL.

ibmcloud sat acl endpoint add --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Um nome ou ID de um ponto de extremidade a ser ativado para essa ACL.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Adicionar um ou mais terminais habilitados a uma ACL

ibmcloud sat acl endpoint add --acl-id ID --endpoint ENDPOINT --connector-id ID

ibmcloud sat acl endpoint help

Mostrar ajuda

ibmcloud sat acl endpoint help

Exemplos

Mostrar ajuda

ibmcloud sat acl endpoint help

ibmcloud sat acl endpoint ls

Satellite

Lista todos os pontos de extremidade habilitados para uma ACL.

ibmcloud sat acl endpoint ls --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todos os pontos de extremidade ativados para uma ACL

ibmcloud sat acl endpoint ls --acl-id ID --connector-id ID

ibmcloud sat acl endpoint rm

Satellite

Remover um ou mais pontos de extremidade habilitados de uma ACL.

ibmcloud sat acl endpoint rm --acl-id ID --endpoint ENDPOINT [--endpoint ENDPOINT ...] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Um nome ou ID de um ponto de extremidade a ser desativado para essa ACL.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover um ou mais terminais habilitados de uma ACL

ibmcloud sat acl endpoint rm --acl-id ID --endpoint ENDPOINT --connector-id ID

ibmcloud sat acl get

Satellite

Visualizar os detalhes de uma ACL.

ibmcloud sat acl get --acl-id ID [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Visualizar os detalhes de uma ACL

ibmcloud sat acl get --acl-id ID --connector-id ID

ibmcloud sat acl help

Mostrar ajuda

ibmcloud sat acl help

Exemplos

Mostrar ajuda

ibmcloud sat acl help

ibmcloud sat acl ls

Satellite

Listar todas as ACLs de um conector ou local do Satellite.

ibmcloud sat acl ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todas as ACLs de um conector ou local do Satellite

ibmcloud sat acl ls --connector-id ID

ibmcloud sat acl rm

Satellite

Excluir uma ACL.

ibmcloud sat acl rm --acl-id ID [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Excluir uma ACL

ibmcloud sat acl rm --acl-id ID --connector-id ID

ibmcloud sat acl subnet add

Satellite

Adicione uma ou mais sub-redes a uma ACL.

ibmcloud sat acl subnet add --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--subnet
Um bloco IP ou CIDR permitido por essa ACL. O valor deve estar totalmente contido nos seguintes CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Exemplos

Adicionar uma ou mais sub-redes a uma ACL

ibmcloud sat acl subnet add --acl-id ID --subnet SUBNET --connector-id ID

ibmcloud sat acl subnet help

Mostrar ajuda

ibmcloud sat acl subnet help

Exemplos

Mostrar ajuda

ibmcloud sat acl subnet help

ibmcloud sat acl subnet rm

Satellite

Remover uma ou mais sub-redes de uma ACL.

ibmcloud sat acl subnet rm --acl-id ID --subnet SUBNET [--subnet SUBNET ...] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--subnet
Um bloco IP ou CIDR permitido por essa ACL. O valor deve estar totalmente contido nos seguintes CIDRs: 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Exemplos

Remover uma ou mais sub-redes de uma ACL

ibmcloud sat acl subnet rm --acl-id ID --subnet SUBNET --connector-id ID

ibmcloud sat acl update

Satellite

Atualizar o nome de uma ACL.

ibmcloud sat acl update --acl-id ID --name NAME [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--acl-id
Especifique o ID da ACL. Para listar todas as ACLs, execute ibmcloud sat acl ls.
--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--name
O novo nome da ACL.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Atualizar o nome de uma ACL

ibmcloud sat acl update --acl-id ID --name NAME --connector-id ID

Comandos do Agente

Anexar ou visualizar os agentes do conector d Satellite.

ibmcloud sat agent attach

Satellite

Obtenha um Agente de Conexão do Satellite para uma plataforma específica. Baixe o Agent .zip para Windows ou obtenha um link para a documentação sobre ambientes Docker.

ibmcloud sat agent attach --platform PLATFORM [-q]

Opções de comando

--platform
A plataforma para o Satellite Connector Agent. Para obter mais informações sobre o Docker, consulte a documentação em https://ibm.biz/satconagent Opções disponíveis: windows, docker
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Obter um Agente de Conector do Satellite para uma plataforma específica

ibmcloud sat agent attach --platform PLATFORM

ibmcloud sat agent help

Mostrar ajuda

ibmcloud sat agent help

Exemplos

Mostrar ajuda

ibmcloud sat agent help

ibmcloud sat agent ls

Satellite

Listar todos os agentes de um conector do Satellite.

ibmcloud sat agent ls --connector-id ID [--output OUTPUT] [-q]

Opções de comando

--connector-id
O ID de um conector do Satellite.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todos os agentes de um conector do Satellite

ibmcloud sat agent ls --connector-id ID

Comandos de cluster

Registrar e gerenciar clusters para uso com configurações do Satellite.

ibmcloud sat cluster get

Virtual Private Cloud Classic infrastructure Satellite

Obtenha os detalhes de um cluster registrado.

ibmcloud sat cluster get --cluster CLUSTER [--output OUTPUT] [-q]

Opções de comando

-c, --cluster
Especifique o nome ou ID do cluster. Para listar os clusters registrados, execute ibmcloud sat cluster ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Obter os detalhes de um cluster registrado

ibmcloud sat cluster get --cluster CLUSTER

ibmcloud sat cluster help

Mostrar ajuda

ibmcloud sat cluster help

Exemplos

Mostrar ajuda

ibmcloud sat cluster help

ibmcloud sat cluster ls

Virtual Private Cloud Classic infrastructure Satellite

Liste todos os clusters registrados em sua conta da IBM Cloud.

ibmcloud sat cluster ls [--filter FILTER] [--limit LIMIT] [--output OUTPUT] [-q]

Opções de comando

--filter
Filtrar clusters registrados por ID do cluster.
--limit
Limite o número de clusters que são retornados.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todos os clusters registrados na sua conta do IBM Cloud

ibmcloud sat cluster ls

ibmcloud sat cluster register

Satellite

Obtenha um comando kubectl para registrar seu cluster em uma configuração Satellite. Efetue login no cluster e execute este comando para instalar um agente de configuração do Satellite. Os clusters que você executa em seu local do Satellite instalam automaticamente esse agente.

ibmcloud sat cluster register --name NAME [-q] [--silent]

Opções de comando

--name
Especifique o nome do cluster que deseja registrar
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--silent
Silencioso. Retornar apenas o comando de registro na saída.

Exemplos

Obtenha um comando kubectl para registrar seu cluster em uma configuração Satellite

ibmcloud sat cluster register --name NAME

ibmcloud sat cluster unregister

Satellite

Remover um registro de cluster. O cluster não está mais inscrito em uma configuração do Satellite, mas o cluster e seus recursos existentes ainda são executados.

ibmcloud sat cluster unregister --cluster CLUSTER [-f] [-q]

Opções de comando

-c, --cluster
Especifique o nome ou ID do cluster. Para listar os clusters registrados, execute ibmcloud sat cluster ls.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover o registro de um cluster

ibmcloud sat cluster unregister --cluster CLUSTER

Comandos do Config

Visualize e gerencie a configuração do Satellite.

ibmcloud sat config create

Satellite

Crie uma configuração para especificar quais recursos do Kubernetes você deseja implementar nos clusters em suas cargas de trabalho do Satellite.

ibmcloud sat config create --name NAME [-q] (--data-location LOCATION | --provider PROVIDER)

Opções de comando

--data-location
Especifique a região da IBM para armazenar os dados de configuração do Satellite. Estratégia: upload direto.
--name
Forneça um nome para a configuração do Satellite.
--provider
Indique o provedor GitOps remoto para a configuração do Satellite. Esse provedor armazena as definições de recurso do Kubernetes. Estratégia: GitOps. Valores permitidos: github, gitlab
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Crie uma configuração para especificar quais recursos do Kubernetes você deseja implantar nos seus clusters nas cargas de trabalho do Satellite

ibmcloud sat config create --name NAME --data-location LOCATION

ibmcloud sat config get

Satellite

Obtenha detalhes de uma configuração do Satellite, como as versões ou assinaturas associadas à configuração.

ibmcloud sat config get --config CONFIG [--output OUTPUT] [-q]

Opções de comando

--config
Especifique o nome ou ID de uma configuração do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat config ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Obter detalhes de uma configuração do Satellite, como as versões ou assinaturas associadas à configuração

ibmcloud sat config get --config CONFIG

ibmcloud sat config help

Mostrar ajuda

ibmcloud sat config help

Exemplos

Mostrar ajuda

ibmcloud sat config help

ibmcloud sat config ls

Satellite

Listar todas as configurações do Satellite em sua conta do IBM Cloud.

ibmcloud sat config ls [--output OUTPUT] [-q]

Opções de comando

--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todas as configurações do “ Satellite ” na sua conta do IBM Cloud

ibmcloud sat config ls

ibmcloud sat config rename

Satellite

Renomear uma configuração do Satellite.

ibmcloud sat config rename --config CONFIG --name NAME [-q]

Opções de comando

--config
Especifique o nome ou ID de uma configuração do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat config ls.
--name
Forneça um novo nome para a configuração do Satellite.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Renomear uma configuração do Satellite

ibmcloud sat config rename --config CONFIG --name NAME

ibmcloud sat config rm

Satellite

Remover uma configuração do Satellite. Todas as assinaturas associadas devem ser removidas primeiro. Todas as versões são excluídas. Faça backup de todas as definições de recurso que você deseja manter.

ibmcloud sat config rm --config CONFIG [-f] [-q]

Opções de comando

--config
Especifique o nome ou ID de uma configuração do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat config ls.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover uma configuração do Satellite

ibmcloud sat config rm --config CONFIG

ibmcloud sat config version create

Satellite

Criar uma versão de configuração para atualizar os recursos existentes do Kubernetes para suas cargas de trabalho do Satellite.

ibmcloud sat config version create --config CONFIG --file-format FORMAT --name NAME --read-config CONFIG [--description DESCRIPTION] [-q]

Opções de comando

--config
Especifique o nome ou ID da configuração do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat config ls.
--description
Inclua uma descrição para a versão de configuração do Satellite.
--file-format
Indique o formato de arquivo da versão de configuração. Opções disponíveis: yaml
--name
Forneça um nome para a versão de configuração do Satellite.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--read-config
Especifique o caminho de arquivo para o arquivo de versão de configuração.

Exemplos

Crie uma versão de configuração para atualizar os recursos existentes do Kubernetes para suas cargas de trabalho do Satellite

ibmcloud sat config version create \
  --config CONFIG \
  --file-format FORMAT \
  --name NAME \
  --read-config CONFIG

ibmcloud sat config version get

Satellite

Obter detalhes para uma versão de configuração do Satellite.

ibmcloud sat config version get --config CONFIG --version VERSION [--output OUTPUT] [-q] [--save-config]

Opções de comando

--config
Especifique o nome ou ID da configuração do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat config ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--save-config
Fazer download e salvar a versão de configuração em um arquivo temporário.
--version
Especifique o nome ou ID da versão de configuração do Satellite. Para listar versões em sua configuração, execute ibmcloud sat config get --config <configuration_name_or_ID>.

Exemplos

Obter detalhes sobre uma versão de configuração do Satellite

ibmcloud sat config version get --config CONFIG --version VERSION

ibmcloud sat config version help

Mostrar ajuda

ibmcloud sat config version help

Exemplos

Mostrar ajuda

ibmcloud sat config version help

ibmcloud sat config version rm

Satellite

Remover uma versão de configuração do Satellite.

ibmcloud sat config version rm --config CONFIG --version VERSION [-f] [-q]

Opções de comando

--config
Especifique o nome ou ID da configuração do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat config ls.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--version
Indique o nome ou ID da versão de configuração do Satellite. Para listar as versões, execute o comando ibmcloud sat config get --config <configuration_name_or_ID>``.

Exemplos

Remover uma versão de configuração do Satellite

ibmcloud sat config version rm --config CONFIG --version VERSION

Comandos do conector

Crie, visualize e modifique conectores do Satellite.

ibmcloud sat connector create

Satellite

Crie um conector do Satellite.

ibmcloud sat connector create --name NAME --region REGION [-q]

Opções de comando

--name
O nome para o conector do Satellite.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--region
A região da IBM Cloud para gerenciar seu conector do Satellite.

Exemplos

Criar um conector do Satellite

ibmcloud sat connector create --name NAME --region REGION

ibmcloud sat connector get

Satellite

Visualize os detalhes de um conector do Satellite.

ibmcloud sat connector get --connector-id ID [--output OUTPUT] [-q]

Opções de comando

--connector-id
O ID de um conector do Satellite.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Visualizar os detalhes de um conector do Satellite

ibmcloud sat connector get --connector-id ID

ibmcloud sat connector help

Mostrar ajuda

ibmcloud sat connector help

Exemplos

Mostrar ajuda

ibmcloud sat connector help

ibmcloud sat connector ls

Satellite

Visualize os conectores do Satellite em sua conta do IBM Cloud.

ibmcloud sat connector ls [--after AFTER] [--first FIRST] [--output OUTPUT] [-q]

Opções de comando

--after
Mostrar Satellite após o cursor fornecido.
--first
Visualize os próximos Satellite, até o primeiro número de conectores.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Visualize os conectores do Satellite em sua conta do IBM Cloud

ibmcloud sat connector ls

ibmcloud sat connector rm

Satellite

Exclua um conector do Satellite.

ibmcloud sat connector rm --connector-id ID [-f] [-q]

Opções de comando

--connector-id
O ID de um conector do Satellite.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Excluir um conector do Satellite

ibmcloud sat connector rm --connector-id ID

Comandos de terminal

Visualizar e gerenciar terminais do Satellite.

ibmcloud sat endpoint authn get

Satellite

Obter as configurações de autenticação de um ponto de extremidade.

ibmcloud sat endpoint authn get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls``.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Obter as configurações de autenticação de um endpoint

ibmcloud sat endpoint authn get --endpoint ENDPOINT --connector-id ID

ibmcloud sat endpoint authn help

Mostrar ajuda

ibmcloud sat endpoint authn help

Exemplos

Mostrar ajuda

ibmcloud sat endpoint authn help

ibmcloud sat endpoint authn rotate

Satellite

Substituir os certificados de autenticação existentes por novos. Existem duas conexões do tipo “ TLS ” no fluxo da solicitação. As opções “ source ” referem-se ao protocolo de handshake “ TLS ” entre a fonte e o serviço Connector. As opções “ destination ” referem-se ao protocolo de handshake “ TLS ” entre o serviço Connector e o servidor de destino. É possível fornecer certificados para uma ou ambas as conexões.. Somente os certificados que você especificar serão substituídos.

ibmcloud sat endpoint authn rotate --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--dest-ca-cert-file
Certificado ou cadeia de CA confiável usado para validar o certificado do servidor de destino. Por exemplo, myCA.pem.
--dest-cert-file
O certificado do cliente utilizado para autenticação no servidor de destino. Por exemplo, myCert.pem.
--dest-key-file
A chave privada do cliente usada para criptografar o certificado de cliente Por exemplo, myKey.pem.
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls``.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--source-ca-cert-file
Certificado ou cadeia de CA confiável usado para validar o certificado do cliente de origem quando source-tls-mode é mútuo. Por exemplo, myCA.pem.
--source-cert-file
O certificado do servidor para apresentar ao cliente de origem. Por exemplo, myCert.pem.
--source-key-file
A chave privada do servidor usada para criptografar o certificado do servidor Por exemplo, myKey.pem.

Exemplos

Substituir os certificados de autenticação existentes por novos

ibmcloud sat endpoint authn rotate --endpoint ENDPOINT --connector-id ID

ibmcloud sat endpoint authn set

Satellite

Definir configurações de autenticação para um ponto de extremidade. Existem duas conexões do tipo “ TLS ” no fluxo da solicitação. As opções “ source ” referem-se ao protocolo de handshake “ TLS ” entre a fonte e o serviço Connector. As opções “ destination ” referem-se ao protocolo de handshake “ TLS ” entre o serviço Connector e o servidor de destino. É possível fornecer certificados para uma ou ambas as conexões.. As configurações não especificadas são definidas para seus valores padrão

ibmcloud sat endpoint authn set --endpoint ENDPOINT [--dest-ca-cert-file FILE] [--dest-cert-file FILE] [--dest-key-file FILE] [--dest-tls-mode MODE] [-q] [--source-ca-cert-file FILE] [--source-cert-file FILE] [--source-key-file FILE] [--source-tls-mode MODE] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--dest-ca-cert-file
Certificado ou cadeia de CA confiável usado para validar o certificado do servidor de destino. Por exemplo, myCA.pem.
--dest-cert-file
O certificado do cliente utilizado para autenticação no servidor de destino. Por exemplo, myCert.pem.
--dest-key-file
A chave privada do cliente usada para criptografar o certificado de cliente Por exemplo, myKey.pem.
--dest-tls-mode
O destino TLS mode. Valores aceitos:simple,mutual,none
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls``.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--source-ca-cert-file
Certificado ou cadeia de CA confiável usado para validar o certificado do cliente de origem quando source-tls-mode é mútuo. Por exemplo, myCA.pem.
--source-cert-file
O certificado do servidor para apresentar ao cliente de origem. Por exemplo, myCert.pem.
--source-key-file
A chave privada do servidor usada para criptografar o certificado do servidor Por exemplo, myKey.pem.
--source-tls-mode
A fonte: TLS. Valores aceitos: simple, mutual

Exemplos

Definir configurações de autenticação para um endpoint

ibmcloud sat endpoint authn set --endpoint ENDPOINT --connector-id ID

ibmcloud sat endpoint create

Satellite

Criar um terminal.

ibmcloud sat endpoint create --dest-hostname HOSTNAME --dest-port PORT --dest-type TYPE --name NAME --source-protocol PROTOCOL [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--output OUTPUT] [-q] [--sni SNI] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--dest-hostname
Indique o nome completo do domínio (FQDN) ou o endereço IP acessível externamente do destino ao qual deseja se conectar. Para pontos de extremidad cloud, esse valor deve corresponder a um endereço IP público ou a um endereço IP privado acessível em IBM Cloud, como um ponto de extremidade de serviço em nuvem privada. Para endpoints do location, esse valor deve ser resolvido a partir dos hosts do plano de controle e estar acessível a partir deles para os locais do Satellite ou onde o agente é executado para o Satellite Connector.
--dest-port
Forneça a porta na qual o recurso de destino atende às solicitações recebidas. Certifique-se de que a porta corresponda ao protocolo de destino.
--dest-protocol
Especifique o protocolo do destino. Se você não especificar esta opção, o protocolo de destino será herdado do protocolo de origem. Valores aceitos: TCP, TLS
--dest-type
Especifique onde o recurso de destino é executado: na nuvem “ IBM Cloud ” (cloud) ou em seu próprio ambiente “ Satellite ” (location). Opções disponíveis: localização, nuvem
--idle-timeout-seconds
Especifique o intervalo de tempo limite em segundos para conexões ativas com o destino. Certifique-se de que seu tempo limite seja compatível com o serviço de destino e as configurações do protocolo keep-alive.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--name
Forneça um nome para o terminal.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--sni
Especifique o indicador de nome do servidor, caso você defina um protocolo de origem tls ou https e deseje que um nome de host separado seja adicionado ao handshake TLS.
--source-protocol
Forneça o protocolo que a origem usa para conectar o recurso de destino. Veja http://ibm.biz/endpoint-protocols. Opções disponíveis: TCP, TLS, HTTP, HTTPS, HTTP-tunnel

Exemplos

Criar um terminal

ibmcloud sat endpoint create \
  --dest-hostname HOSTNAME \
  --dest-port PORT \
  --dest-type TYPE \
  --name NAME \
  --source-protocol PROTOCOL \
  --connector-id ID

ibmcloud sat endpoint disable

Satellite

Desativar um ponto de extremidade.

ibmcloud sat endpoint disable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``.
-f
Force o comando a ser executado sem prompts do usuário.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Desativar um terminal

ibmcloud sat endpoint disable --endpoint ENDPOINT --connector-id ID

ibmcloud sat endpoint enable

Satellite

Habilite um ponto de extremidade.

ibmcloud sat endpoint enable --endpoint ENDPOINT [-f] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``.
-f
Force o comando a ser executado sem prompts do usuário.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Ativar um endpoint

ibmcloud sat endpoint enable --endpoint ENDPOINT --connector-id ID

ibmcloud sat endpoint get

Satellite

Visualize os detalhes de um terminal.

ibmcloud sat endpoint get --endpoint ENDPOINT [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Visualizar os detalhes de um endpoint

ibmcloud sat endpoint get --endpoint ENDPOINT --connector-id ID

ibmcloud sat endpoint help

Mostrar ajuda

ibmcloud sat endpoint help

Exemplos

Mostrar ajuda

ibmcloud sat endpoint help

ibmcloud sat endpoint ls

Satellite

Liste todos os terminais em um local do Satellite.

ibmcloud sat endpoint ls [--output OUTPUT] [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todos os endpoints em um local do Satellite

ibmcloud sat endpoint ls --connector-id ID

ibmcloud sat endpoint rm

Satellite

Excluir um terminal.

ibmcloud sat endpoint rm --endpoint ENDPOINT [-q] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Excluir um endpoint

ibmcloud sat endpoint rm --endpoint ENDPOINT --connector-id ID

ibmcloud sat endpoint update

Satellite

Atualize um terminal. Somente as opções que você especifica são atualizadas.

ibmcloud sat endpoint update --endpoint ENDPOINT [--dest-hostname HOSTNAME] [--dest-port PORT] [--dest-protocol PROTOCOL] [--idle-timeout-seconds SECONDS] [--name NAME] [-q] [--sni SNI] [--source-protocol PROTOCOL] (--connector-id ID | --location LOCATION)

Opções de comando

--connector-id
O ID do conector “ Satellite ”. Para localizar o ID do conector executar ibmcloud sat connector ls.
--dest-hostname
Indique o nome completo do domínio (FQDN) ou o endereço IP acessível externamente do destino ao qual deseja se conectar. Para pontos de extremidad cloud, esse valor deve corresponder a um endereço IP público ou a um endereço IP privado acessível em IBM Cloud, como um ponto de extremidade de serviço em nuvem privada. Para endpoints do location, esse valor deve ser resolvido a partir dos hosts do plano de controle e estar acessível a partir deles para os locais do Satellite ou onde o agente é executado para o Satellite Connector.
--dest-port
Forneça a porta na qual o recurso de destino atende às solicitações recebidas. Certifique-se de que a porta corresponda ao protocolo de destino.
--dest-protocol
Especifique o protocolo do destino. Se você não especificar esta opção, o protocolo de destino será herdado do protocolo de origem. Valores aceitos: TCP, TLS
--endpoint
Especifique o nome ou ID do terminal. Para listar todos os endpoints, execute ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION)``.
--idle-timeout-seconds
Especifique o intervalo de tempo limite em segundos para conexões ativas com o destino. Certifique-se de que seu tempo limite seja compatível com o serviço de destino e as configurações do protocolo keep-alive.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--name
Forneça um novo nome para o terminal.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--sni
Especifique o indicador de nome do servidor, caso você defina um protocolo de origem tls ou https e deseje que um nome de host separado seja adicionado ao handshake TLS.
--source-protocol
Forneça o protocolo que a origem usa para conectar o recurso de destino. Veja http://ibm.biz/endpoint-protocols. Valores aceitos: TCP, TLS, HTTP, HTTPS, HTTP-tunnel

Exemplos

Atualizar um endpoint

ibmcloud sat endpoint update --endpoint ENDPOINT --connector-id ID

Comandos experimentais

[Expires on 2024-11-25] Experimente com novos comandos. IMPORTANTE: Os comandos aqui listados serão descontinuados após o “ [date] ” (fim da vida útil) indicado em sua descrição.

ibmcloud sat experimental endpoint help

Mostrar ajuda

ibmcloud sat experimental endpoint help

Exemplos

Mostrar ajuda

ibmcloud sat experimental endpoint help

ibmcloud sat experimental help

Mostrar ajuda

ibmcloud sat experimental help

Exemplos

Mostrar ajuda

ibmcloud sat experimental help

Comandos Group

Visualizar e gerenciar grupos de clusters do Satellite. Os grupos de clusters são usados para assinar clusters para configurações do Satellite de recursos do Kubernetes.

ibmcloud sat group attach

Satellite

Inclua um cluster em seu grupo de clusters. O cluster pode ser executado em seu local do Satellite ou na IBM Cloud. Para incluir um cluster executado na IBM Cloud, deve-se primeiro registrar o cluster com o Satellite Config.

ibmcloud sat group attach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-q]

Opções de comando

-c, --cluster
Especificar o nome ou o ID do cluster. Para listar os clusters registrados, execute ibmcloud sat cluster ls.
-g, --group
Especifique o nome ou ID de um grupo de clusters do Satellite. Para listar grupos de clusters disponíveis, execute ibmcloud sat group ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Adicione um cluster ao seu grupo de clusters

ibmcloud sat group attach --cluster CLUSTER --group GROUP

ibmcloud sat group create

Satellite

Crie um grupo de clusters. Em seguida, é possível assinar o grupo de clusters para uma configuração do Satellite.

ibmcloud sat group create --name NAME [--cluster CLUSTER ...] [-q]

Opções de comando

-c, --cluster
Especifique o nome ou ID do cluster para incluir no grupo de clusters. Para listar os clusters registrados, execute ibmcloud sat cluster ls.
--name
Forneça um nome do grupo de clusters do Satellite.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Criar um grupo de clusters

ibmcloud sat group create --name NAME

ibmcloud sat group detach

Satellite

Remover um ou mais clusters de seu grupo de clusters do Satellite e excluir os recursos do Kubernetes que eram gerenciados pelas assinaturas do grupo.

ibmcloud sat group detach --cluster CLUSTER [--cluster CLUSTER ...] --group GROUP [-f] [-q]

Opções de comando

-c, --cluster
Especificar o nome ou o ID do cluster. Para listar os clusters do seu grupo de clusters, execute o comando ibmcloud sat group get --group <cluster_group_name_or_ID>``.
-f
Force o comando a ser executado sem prompts do usuário.
-g, --group
Especifique o nome ou ID de um grupo de clusters do Satellite. Para listar grupos de clusters disponíveis, execute ibmcloud sat group ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remove um ou mais clusters do seu grupo de clusters do Satellite e exclui os recursos Kubernetes que eram gerenciados pelas assinaturas do grupo

ibmcloud sat group detach --cluster CLUSTER --group GROUP

ibmcloud sat group get

Satellite

Obter informações detalhadas para um grupo de clusters do Satellite.

ibmcloud sat group get --group GROUP [--output OUTPUT] [-q]

Opções de comando

-g, --group
Especifique o nome ou ID de um grupo de clusters do Satellite. Para listar os clusters registrados, execute ibmcloud sat cluster ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Obter informações detalhadas sobre um grupo de clusters do Satellite

ibmcloud sat group get --group GROUP

ibmcloud sat group help

Mostrar ajuda

ibmcloud sat group help

Exemplos

Mostrar ajuda

ibmcloud sat group help

ibmcloud sat group ls

Satellite

Listar todos os grupos de clusters do Satellite em sua conta da IBM Cloud.

ibmcloud sat group ls [--output OUTPUT] [-q]

Opções de comando

--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todos os grupos de cluster do Satellite na sua conta do IBM Cloud

ibmcloud sat group ls

ibmcloud sat group rm

Satellite

Remover um grupo de clusters do Satellite, o que cancela a assinatura de clusters e exclui os recursos do Kubernetes que eram gerenciados pelas assinaturas dos grupos.

ibmcloud sat group rm --group GROUP [-f] [-q]

Opções de comando

-f
Force o comando a ser executado sem prompts do usuário.
-g, --group
Especifique o nome ou ID de um grupo de clusters do Satellite. Para listar grupos de clusters disponíveis, execute ibmcloud sat group ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover um grupo de clusters do Satellite, o que cancela as assinaturas dos clusters e exclui os recursos do Kubernetes que eram gerenciados pelas assinaturas do grupo

ibmcloud sat group rm --group GROUP

Comandos do host

Visualizar e modificar hosts do Satellite.

ibmcloud sat host assign

Satellite

Designe um host a um cluster ou plano de controle do local do Satellite.

ibmcloud sat host assign --location LOCATION [--cluster CLUSTER] [--host HOST] [--host-label LABEL ...] [-q] [--worker-pool POOL] [--zone ZONE]

Opções de comando

--cluster
O nome ou ID do cluster ao qual designar o host. Para listar os clusters disponíveis, execute o comando ibmcloud sat cluster ls``. Se nenhum cluster for fornecido, o host será designado automaticamente para o plano de controle do Satellite.
--host
O nome ou o ID do host a ser designado. Para designar hosts automaticamente com base nos rótulos, não inclua essa opção. Para recuperar o ID do host, execute ibmcloud sat host ls --location <location_ID_or_name>.
--host-label, --hl
Insira quaisquer rótulos como pares chave-valor para identificar o host a ser atribuído ao seu plano de controle do Satellite ou ao seu cluster do Red Hat OpenShift. O primeiro host que tem esse rótulo e é não designado é automaticamente designado ao cluster ou plano de controle. Para encontrar rótulos de host disponíveis, execute ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-p, --worker-pool
O nome ou ID do conjunto de trabalhadores dentro do cluster para o qual designar o host. Se nenhum conjunto de trabalhadores for especificado, o host será designado ao conjunto de trabalhadores padrão.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--zone
O nome ou ID da zona para a qual designar o host. Para encontrar as zonas disponíveis, acesse ibmcloud sat location get --location <location_name_or_ID> e procure o campo “ Host Zones ”.

Exemplos

Atribuir um host a um plano de controle de localização ou cluster do Satellite

ibmcloud sat host assign --location LOCATION

ibmcloud sat host attach

Satellite

Crie e faça o download de um script que possa ser executado em seus hosts para anexá-los ao seu local. Para os locais ativados pelo RHCOS, o script é um arquivo de ignição.

ibmcloud sat host attach --location LOCATION [--host-label LABEL ...] [--host-link-agent-endpoint ENDPOINT] [--operating-system SYSTEM] [-q] [--reset-key]

Opções de comando

--host-label, --hl
Insira quaisquer rótulos como pares chave-valor para identificar o host a ser atribuído ao seu plano de controle do Satellite ou ao seu cluster do Red Hat OpenShift. O primeiro host que tem esse rótulo e é não designado é automaticamente designado ao cluster ou plano de controle. Para encontrar rótulos de host disponíveis, execute ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.
--host-link-agent-endpoint
O terminal usado pelo agente de link para se conectar ao servidor de túnel de link.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--operating-system
O sistema operacional dos hosts que você deseja anexar ao seu local. Para conectar hosts RHCOS, seu local deve ser ativado por RHCOS. Valores aceitos: RHEL, RHCOS
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--reset-key
Redefina a chave que o plano de controle usa para conectar e atribuir hosts no local. Consulte https://ibm.biz/reset-key.

Exemplos

Crie e baixe um script que você possa executar em seus hosts para associá-los ao seu local

ibmcloud sat host attach --location LOCATION

ibmcloud sat host get

Satellite

Visualize os detalhes de um host do Satellite.

ibmcloud sat host get --host HOST --location LOCATION [--output OUTPUT] [-q]

Opções de comando

--host
O ID do host do Satellite. Para descobrir o ID do host, execute o comando ibmcloud sat host ls <location_ID_or_name>``.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Visualizar os detalhes de um host do Satellite

ibmcloud sat host get --host HOST --location LOCATION

ibmcloud sat host help

Mostrar ajuda

ibmcloud sat host help

Exemplos

Mostrar ajuda

ibmcloud sat host help

ibmcloud sat host ls

Satellite

Liste todos os hosts que estão anexados a um local do Satellite, incluindo os que são designados a clusters no plano de controle.

ibmcloud sat host ls --location LOCATION [--output OUTPUT] [-q]

Opções de comando

--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todos os hosts vinculados a um local do Satellite, incluindo os hosts atribuídos a clusters ou ao plano de controle

ibmcloud sat host ls --location LOCATION

ibmcloud sat host rm

Satellite

Remover um host de um local do Satellite.

ibmcloud sat host rm --host HOST --location LOCATION [-f] [-q]

Opções de comando

-f
Force o comando a ser executado sem prompts do usuário.
--host
O nome ou ID do host a ser removido.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover um host de um local do Satellite

ibmcloud sat host rm --host HOST --location LOCATION

ibmcloud sat host update

Satellite

Atualize as informações do host, como zonas e rótulos.

ibmcloud sat host update --host HOST --location LOCATION [--host-label LABEL ...] [-q] [--zone ZONE]

Opções de comando

--host
O nome ou o ID do host a ser designado. Para designar hosts automaticamente com base nos rótulos, não inclua essa opção.
--host-label, --hl
Insira quaisquer rótulos como pares chave-valor para identificar o host a ser atribuído ao seu plano de controle do Satellite ou ao seu cluster do Red Hat OpenShift. O primeiro host que tem esse rótulo e é não designado é automaticamente designado ao cluster ou plano de controle. Para encontrar rótulos de host disponíveis, execute ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--zone
O nome ou ID da zona para associar ao host. Não é possível mudar a zona dos hosts designados a um recurso, como um cluster. Deve-se remover sua designação primeiro. Para listar as zonas disponíveis, execute o comando ibmcloud sat location get --location ``.

Exemplos

Atualizar informações do host, como zonas e rótulos

ibmcloud sat host update --host HOST --location LOCATION

Comandos de teclado

Visualizar e gerenciar as chaves de configuração Satellite.

ibmcloud sat key help

Mostrar ajuda

ibmcloud sat key help

Exemplos

Mostrar ajuda

ibmcloud sat key help

ibmcloud sat key ls

Satellite

Liste todas as chaves da configuração Satellite em sua conta IBM Cloud.

ibmcloud sat key ls [--output OUTPUT] [-q]

Opções de comando

--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Liste todas as chaves de configuração do Satellite em sua conta IBM Cloud

ibmcloud sat key ls

ibmcloud sat key rm

Satellite

Remover uma chave de configuração Satellite. Qualquer cluster que ainda use essa chave não pode se conectar ao Satellite Config.

ibmcloud sat key rm --key KEY [-f] [-q]

Opções de comando

-f
Force o comando a ser executado sem prompts do usuário.
--key
O nome ou ID de uma chave do Satellite Config.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover uma chave de configuração do tipo “ Satellite ”

ibmcloud sat key rm --key KEY

ibmcloud sat key rotate

Satellite

Gere uma nova chave para uso dos clusters gerenciados para conectar a configuração Satellite.

ibmcloud sat key rotate --name NAME [-f] [-q]

Opções de comando

-f
Force o comando a ser executado sem prompts do usuário.
--name
O nome da nova chave de configuração Satellite.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Gerar uma nova chave para que os clusters gerenciados se conectem à configuração d Satellite

ibmcloud sat key rotate --name NAME

Comandos de localização

Crie, visualize e modifique locais do Satellite.

ibmcloud sat location create

Satellite

Crie um local do Satellite. Um local do Satellite é uma representação de um ambiente no provedor de infraestrutura. Depois de criar um local, vincule hosts de zonas distintas do seu ambiente de infraestrutura de suporte usando o comando ibmcloud sat host attach .

ibmcloud sat location create --managed-from REGION --name NAME [--capability CAPABILITY ...] [--coreos-enabled] [--cos-bucket BUCKET] [--description DESCRIPTION] [--ha-zone ZONE ...] [--physical-address ADDRESS] [--pod-network-interface-selection SELECTION] [--pod-subnet SUBNET] [--provider PROVIDER] [--provider-credential CREDENTIAL] [--provider-region REGION] [-q] [--service-subnet SUBNET]

Opções de comando

--capability
Um recurso da unidade de negócios “ Satellite ”.
--coreos-enabled
Ative os recursos do Red Hat CoreOS para o local do Satellite. Essa ação não pode ser desfeita Consulte https://ibm.biz/infra-os.
--cos-bucket
Especifique o nome do bucket do IBM Cloud Object Storage para armazenar os dados do plano de controle do local do Satellite. Caso contrário, um novo depósito será criado para você.
--description
Insira uma descrição para o local do Satellite.
--ha-zone
Especifique a zona para o seu local. Para garantir alta disponibilidade, especifique três zonas para a sua localização, como --ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME. Os nomes das zonas devem corresponder exatamente aos nomes das zonas correspondentes em seu provedor de infraestrutura no qual você planeja criar hosts.
--managed-from
Selecione a região da IBM Cloud da qual gerenciar seu local do Satellite. Escolha uma região próxima ao seu data center no local para obter o melhor desempenho. Veja https://ibm.biz/sat-region.
--name
Especifique um nome para o local do Satellite. Os nomes de locais devem começar com uma letra, podem conter letras, números, pontos (.) e hífens (-), e devem ter menos de 36 caracteres. Não reutilize os nomes, mesmo que o outro local seja excluído.
--physical-address
O endereço físico da localização do Satellite.
--pod-network-interface-selection
O método para seleção da interface de rede de nó para a rede de pod interno. Essa opção só pode ser usada se você também ativar Red Hat CoreOS com a opção --coreos-enabled. Para fornecer um endereço IP ou URL direto, especifique can-reach=<url> ou can-reach=<ip_address>. Para escolher uma interface, especifique interface=<network_interface>.
--pod-subnet
Especifique um CIDR de sub-rede customizado para fornecer endereços IP privados para pods. Essa opção é usada apenas se você ativar o recurso “ Red Hat ” ( CoreOS ) com a opção “ --coreos-enabled ”. A sub-rede deve ter o tamanho de /23 ou mais. Consulte https://ibm.biz/sat-location-create Valor padrão: '172.16.0.0/16
--provider
Indique o provedor de infraestrutura para usar para o local do Satellite. Se você incluir essa opção, também deverá incluir a opção --provider-credential. Valores aceitos: aws, azure, gcp, vmware
--provider-credential
Especifique o caminho para um arquivo JSON em sua máquina local que tenha as credenciais do provedor de infraestrutura para o local do Satellite. O formato da credencial é específico para o provedor. Consulte http://ibm.biz/sat-infra-creds..
--provider-region
Especifique a região no provedor de infraestrutura no qual você planeja criar os hosts para o local do Satellite. Se você incluir essa opção, também deverá incluir a opção --provider.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--service-subnet
Especifique um CIDR de sub-rede customizado para fornecer endereços IP privados para serviços. Essa opção é usada apenas se você ativar o recurso “ Red Hat ” ( CoreOS ) com a opção “ --coreos-enabled ”. A sub-rede deve ter o tamanho de /24 ou mais. Consulte https://ibm.biz/sat-location-create Valor-padrão: 172.20.0.0/16

Exemplos

Criar uma localização do Satellite

ibmcloud sat location create --managed-from REGION --name NAME

ibmcloud sat location dns get

Satellite

Visualize os detalhes de um subdomínio registrado em um local Satellite.

ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN [--output OUTPUT] [-q]

Opções de comando

--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--subdomain
Especifique o nome do subdomínio. Para listar os subdomínios existentes, execute ibmcloud sat location dns ls --location <ID>.

Exemplos

Visualizar os detalhes de um subdomínio registrado em um endereço Satellite

ibmcloud sat location dns get --location LOCATION --subdomain SUBDOMAIN

ibmcloud sat location dns help

Mostrar ajuda

ibmcloud sat location dns help

Exemplos

Mostrar ajuda

ibmcloud sat location dns help

ibmcloud sat location dns ls

Satellite

Liste os subdomínios registrados em um local do Satellite.

ibmcloud sat location dns ls --location LOCATION [--output OUTPUT] [-q]

Opções de comando

--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar os subdomínios registrados em um endereço Satellite

ibmcloud sat location dns ls --location LOCATION

ibmcloud sat location dns register

Satellite

Configure um subdomínio para os hosts designados ao plano de controle em um local do Satellite.

ibmcloud sat location dns register --ip IP [--ip IP ...] --location LOCATION [--output OUTPUT] [-q]

Opções de comando

--ip
Especifique o endereço IP de cada host do plano de controle, no formato --ip x.x.x.1 --ip x.x.x.2 --ip x.x.x.3. Para clusters de várias zonas, use um endereço IP de cada zona. Para encontrar o endereço IP, acesse ibmcloud sat host ls --location <location_ID_or_name> e procure por Worker IP para os hosts identificados como infrastructure.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Defina um subdomínio para os hosts atribuídos ao plano de controle em um local Satellite

ibmcloud sat location dns register --ip IP --location LOCATION

ibmcloud sat location get

Satellite

Visualize os detalhes de um local do Satellite.

ibmcloud sat location get --location LOCATION [--output OUTPUT] [-q]

Opções de comando

--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Veja os detalhes de uma unidade da Satellite

ibmcloud sat location get --location LOCATION

ibmcloud sat location help

Mostrar ajuda

ibmcloud sat location help

Exemplos

Mostrar ajuda

ibmcloud sat location help

ibmcloud sat location ls

Satellite

Liste todos os locais do Satellite em sua conta do IBM Cloud.

ibmcloud sat location ls [--output OUTPUT] [-q]

Opções de comando

--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Liste todas as lojas da Satellite na sua conta do IBM Cloud

ibmcloud sat location ls

ibmcloud sat location rm

Satellite

Exclua um local. Antes de executar esse comando, faça backup de suas configurações e remova todos os hosts e clusters que são executados no local. A infraestrutura de host subjacente não é excluída automaticamente quando você exclui um local. Essa ação não pode ser desfeita

ibmcloud sat location rm --location LOCATION [-f] [-q]

Opções de comando

-f
Force o comando a ser executado sem prompts do usuário.
--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Excluir um local

ibmcloud sat location rm --location LOCATION

ibmcloud sat location update

Satellite

Atualize o nome ou a descrição de um local do Satellite.

ibmcloud sat location update --location-id ID [--description DESCRIPTION] [--name NAME] [-q]

Opções de comando

--description
Insira uma nova descrição para o local “ Satellite ”. O tamanho da descrição é limitado a 400 bytes.
--location-id
O ID do local “ Satellite ”. Para encontrar o ID do local, acesse ibmcloud sat location ls.
--name
Especifique um novo nome para o local “ Satellite ”. Os nomes de locais devem começar com uma letra, podem conter letras, números, pontos (.) e hífens (-), e devem ter menos de 36 caracteres. Não reutilize nomes, inclusive nomes de locais excluídos.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Atualizar o nome ou a descrição de um local do Satellite

ibmcloud sat location update --location-id ID

Comandos de mensagens

Visualize as mensagens atuais do usuário.

ibmcloud sat messages

Virtual Private Cloud Classic infrastructure Satellite

Visualize as mensagens atuais do usuário.

ibmcloud sat messages [-q]

Opções de comando

-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Visualizar as mensagens do usuário atual

ibmcloud sat messages

Comandos de recurso

Procure e visualize recursos do Kubernetes que são gerenciados por uma configuração do Satellite.

ibmcloud sat resource get

Satellite

Visualize os detalhes de um recurso do Kubernetes gerenciado por uma configuração do Satellite.

ibmcloud sat resource get --resource RESOURCE [--history HISTORY] [--output OUTPUT] [-q] [--save-data]

Opções de comando

--history
O ID do histórico para o recurso.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--resource
Especifique o ID de recurso do Kubernetes. Para encontrar recursos sobre o “ Kubernetes ”, acesse ibmcloud sat resource ls.
--save-data
Faça download e salve uma definição de recurso do Kubernetes em um arquivo temporário.

Exemplos

Visualizar os detalhes de um recurso do Kubernetes gerenciado por uma configuração do Satellite

ibmcloud sat resource get --resource RESOURCE

ibmcloud sat resource help

Mostrar ajuda

ibmcloud sat resource help

Exemplos

Mostrar ajuda

ibmcloud sat resource help

ibmcloud sat resource history get

Satellite

Obter histórico para um recurso do Kubernetes.

ibmcloud sat resource history get --resource RESOURCE [--limit LIMIT] [--output OUTPUT] [-q]

Opções de comando

--limit
Especifique o número máximo de entradas de histórico a serem retornadas.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--resource
O ID do recurso do Kubernetes.

Exemplos

Obter o histórico de um recurso do Kubernetes

ibmcloud sat resource history get --resource RESOURCE

ibmcloud sat resource history help

Mostrar ajuda

ibmcloud sat resource history help

Exemplos

Mostrar ajuda

ibmcloud sat resource history help

ibmcloud sat resource ls

Satellite

Procure os recursos do Kubernetes que são gerenciados pelo Satellite.

ibmcloud sat resource ls [--limit LIMIT] [--output OUTPUT] [-q] [--search SEARCH] (--cluster CLUSTER | --subscription SUBSCRIPTION)

Opções de comando

-c, --cluster
Especifique o nome ou ID do cluster registrado no qual o recurso Kubernetes é executado. Para localizar clusters registrados, acesse ibmcloud sat cluster ls.
--limit
Especifique o número máximo de entradas de recurso para a procura retornar.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--search
Indique a sequência para filtrar resultados da procura de recursos do Kubernetes, como um nome de pod ou namespace.
--subscription
Especifique o ID ou nome da assinatura do Satellite. Para localizar assinaturas, execute o comando ibmcloud sat cluster ls``.

Exemplos

Pesquise recursos do Kubernetes gerenciados por Satellite

ibmcloud sat resource ls --cluster CLUSTER

Comandos de serviço

Visualizar clusters de serviço do Satellite.

ibmcloud sat service help

Mostrar ajuda

ibmcloud sat service help

Exemplos

Mostrar ajuda

ibmcloud sat service help

ibmcloud sat service ls

Satellite

Liste todos os clusters de serviço do Satellite em seu local para revisar detalhes, como recursos do host solicitado.

ibmcloud sat service ls --location LOCATION [--output OUTPUT] [-q]

Opções de comando

--location
O nome ou ID do local do Satellite. Para descobrir o ID ou o nome do local, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Liste todos os clusters de serviço do Satellite em sua localidade para analisar detalhes, como os recursos de host solicitados

ibmcloud sat service ls --location LOCATION

Comandos de armazenamento

Visualize e gerencie recursos de armazenamento do Satellite.

ibmcloud sat storage assignment autopatch disable

O comando storage assignment autopatch disable é um recurso beta..

Satellite

Desativar as correções automáticas para uma atribuição de armazenamento do tipo “ Satellite ”.

ibmcloud sat storage assignment autopatch disable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)

Opções de comando

--all
Desativar correções automáticas para todas as designações de armazenamento do Satellite de uma configuração de armazenamento.
--assignment
O ID de uma designação de armazenamento do Satellite. Para listar as atribuições de armazenamento disponíveis da configuração, execute o comando ibmcloud sat storage assignment ls --config CONFIG``.
--config
O nome ou ID de uma configuração de armazenamento do Satellite. Para listar configurações de armazenamento disponíveis, execute ibmcloud sat storage config ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Desativar correções automáticas para uma atribuição de armazenamento do Satellite

ibmcloud sat storage assignment autopatch disable --config CONFIG --all

ibmcloud sat storage assignment autopatch enable

O comando storage assignment autopatch enable é um recurso beta..

Satellite

Ativar patches automáticos para uma atribuição de armazenamento do tipo “ Satellite ”.

ibmcloud sat storage assignment autopatch enable --config CONFIG [-q] (--all | --assignment ASSIGNMENT)

Opções de comando

--all
Ative as correções automáticas para todas as designações de armazenamento do Satellite de uma configuração de armazenamento
--assignment
O ID de uma designação de armazenamento do Satellite. Para listar as atribuições de armazenamento disponíveis da configuração, execute o comando ibmcloud sat storage assignment ls --config CONFIG``.
--config
O nome ou ID de uma configuração de armazenamento do Satellite. Para listar configurações de armazenamento disponíveis, execute ibmcloud sat storage config ls.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Ativar patches automáticos para uma atribuição de armazenamento do Satellite

ibmcloud sat storage assignment autopatch enable --config CONFIG --all

ibmcloud sat storage assignment autopatch help

Mostrar ajuda

ibmcloud sat storage assignment autopatch help

Exemplos

Mostrar ajuda

ibmcloud sat storage assignment autopatch help

ibmcloud sat storage assignment create

Satellite

Crie uma designação para implementar suas configurações de armazenamento nos clusters na localização do Satellite.

ibmcloud sat storage assignment create --config CONFIG [--name NAME] [-q] (--cluster CLUSTER | --group GROUP | --service-cluster-id CLUSTER)

Opções de comando

-c, --cluster
Especifique o ID do cluster do Satellite para a designação. Para encontrar o ID do cluster, execute ibmcloud oc cluster ls --provider satellite.
--config
Especifique a configuração de armazenamento Satellite para a designação. para localizar configurações, execute ibmcloud sat storage config ls..
-g, --group
Especifique os grupos de cluster para a designação. Para localizar grupos de clusters, execute o comando ibmcloud sat group ls``.
--name
Forneça um nome para a designação de armazenamento do Satellite.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--service-cluster-id
Especifique o ID do cluster de serviço para a designação. Para encontrar o ID do cluster de serviços, execute o comando ibmcloud sat service ls --location ``.

Exemplos

Crie uma tarefa para implantar suas configurações de armazenamento nos clusters do seu local do Satellite

ibmcloud sat storage assignment create --config CONFIG --cluster CLUSTER

ibmcloud sat storage assignment get

Satellite

Obtenha os detalhes de uma designação de armazenamento do Satellite.

ibmcloud sat storage assignment get --assignment ASSIGNMENT [--output OUTPUT] [-q]

Opções de comando

--assignment
Especifique o ID de uma designação de armazenamento do Satellite.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Veja os detalhes de uma atribuição de armazenamento do Satellite

ibmcloud sat storage assignment get --assignment ASSIGNMENT

ibmcloud sat storage assignment help

Mostrar ajuda

ibmcloud sat storage assignment help

Exemplos

Mostrar ajuda

ibmcloud sat storage assignment help

ibmcloud sat storage assignment ls

Satellite

Liste as designações de armazenamento do Satellite em sua conta da IBM Cloud.

Para listar todas as designações para um cluster de serviço como Service Admin: ibmcloud sat storage designação ls--service-cluster-id CONJUNTO.

Para listar todas as designações para um cluster de serviço como Administrador de local: ibmcloud sat storage designação ls--location LOCALIZAÇÃO--service-cluster-id CONJUNTO.

Para listar todas as atribuições de uma configuração: ibmcloud sat storage assignment ls --config CONFIG.

ibmcloud sat storage assignment ls [--output OUTPUT] [-q] (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)

Opções de comando

-c, --cluster
Especifique o ID do cluster do Satellite para as designações. Para obter o ID do cluster, execute o comando ibmcloud oc cluster ls --provider satellite``.
--config
Especifique o nome ou ID de uma configuração de armazenamento do Satellite. Para listar configurações de armazenamento disponíveis, execute ibmcloud sat storage config ls.
--location
Especifique o nome de um local do Satellite. Para listar os locais disponíveis, execute o comando ibmcloud sat location ls``. Esta opção não pode ser usada pelo administrador de serviço.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--service-cluster-id
Especifique o ID do cluster de serviço para as designações. Para encontrar o ID do cluster de serviços, execute o comando ibmcloud sat service ls --location ``.

Exemplos

Liste as alocações de armazenamento do Satellite na sua conta do IBM Cloud

ibmcloud sat storage assignment ls --cluster CLUSTER

ibmcloud sat storage assignment patch

Satellite

Aplique as alterações de configuração de armazenamento para as designações associadas

ibmcloud sat storage assignment patch --assignment ASSIGNMENT [-f] [-q]

Aliases: ibmcloud sat upgrade

Opções de comando

--assignment
Especifique o ID de uma designação de armazenamento do Satellite. Para listar as atribuições disponíveis, execute o comando ibmcloud sat storage assignment ls``.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Aplicar as alterações na configuração de armazenamento às atribuições associadas

ibmcloud sat storage assignment patch --assignment ASSIGNMENT

ibmcloud sat storage assignment rm

Satellite

Remova uma designação de armazenamento do Satellite. Os recursos do Kubernetes são excluídos de todos os clusters em seu local do Satellite, mas a Configuração permanece.

ibmcloud sat storage assignment rm --assignment ASSIGNMENT [-f] [-q]

Opções de comando

--assignment
Especifique o ID de uma designação de armazenamento do Satellite. Para encontrar tarefas, acesse ibmcloud sat storage assignment ls.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover uma atribuição de armazenamento do Satellite

ibmcloud sat storage assignment rm --assignment ASSIGNMENT

ibmcloud sat storage assignment update

Satellite

Atualize uma designação de armazenamento do Satellite.

ibmcloud sat storage assignment update --assignment ASSIGNMENT [-f] [--group GROUP ...] [--name NAME] [-q]

Opções de comando

--assignment
Especifique o ID de uma designação de armazenamento do Satellite.
-f
Force o comando a ser executado sem prompts do usuário.
-g, --group
Especifique os novos grupos de clusters para a designação. Para listar os grupos disponíveis, execute o comando ibmcloud sat group ls``.
--name
Forneça um novo nome para a designação de armazenamento do Satellite.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Atualizar uma atribuição de armazenamento do Satellite

ibmcloud sat storage assignment update --assignment ASSIGNMENT

ibmcloud sat storage config class add

Satellite

Crie uma classe de armazenamento customizada do Satellite.

ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM [--param PARAM ...] [-q]

Opções de comando

--config-name
Especifique o nome da configuração de armazenamento para a classe de armazenamento customizada. Para listar as configurações de armazenamen Satellite, execute o comando ibmcloud sat storage config ls``.
--name
Forneça um nome para a classe de armazenamento customizada.
-p, --param
Especifique um par de valores “ key=value ” para os parâmetros da classe de armazenamento. Para visualizar os parâmetros da classe de armazenamento em um modelo de armazenamento, execute o comando ibmcloud sat storage template get``.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Criar uma classe de armazenamento personalizada do tipo “ Satellite ”

ibmcloud sat storage config class add --config-name NAME --name NAME --param PARAM

ibmcloud sat storage config class get

Satellite

Obter os detalhes de uma classe de armazenamento do Satellite.

ibmcloud sat storage config class get --class CLASS --config CONFIG [--output OUTPUT] [-q]

Opções de comando

--class
Especifique o nome de uma classe de armazenamento do Satellite.
--config
Especifique o nome ou ID de uma configuração de armazenamento do Satellite. Para listar as configurações de armazenamen Satellite, execute o comando ibmcloud sat storage config ls``.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Obter os detalhes de uma classe de armazenamento do tipo “ Satellite ”

ibmcloud sat storage config class get --class CLASS --config CONFIG

ibmcloud sat storage config class help

Mostrar ajuda

ibmcloud sat storage config class help

Exemplos

Mostrar ajuda

ibmcloud sat storage config class help

ibmcloud sat storage config class ls

Satellite

Listar as classes de armazenamento em uma configuração de armazenamento do Satellite

ibmcloud sat storage config class ls --config CONFIG [--output OUTPUT] [-q] [--show-params]

Opções de comando

--config
Especifique o nome ou ID de uma configuração de armazenamento do Satellite. Para listar as configurações de armazenamen Satellite, execute o comando ibmcloud sat storage config ls``.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--show-params
Inclua esta opção para listar todos os detalhes do parâmetro de classe de armazenamento.

Exemplos

Listar as classes de armazenamento em uma configuração de armazenamento do Satellite

ibmcloud sat storage config class ls --config CONFIG

ibmcloud sat storage config create

Satellite

Criar uma configuração de armazenamento do Satellite para instalar drivers de armazenamento em seus clusters.

ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME [--param PARAM ...] [-q] [--template-version VERSION]

Opções de comando

--location
Insira o ID ou nome do local para a configuração de armazenamento. Para encontrar locais disponíveis, acesse ibmcloud sat location ls.
--name
Especifique o nome da configuração de armazenamento.
-p, --param
Especifique um par “ key=value ” para os parâmetros de configuração. Para visualizar os parâmetros de configuração de um modelo de armazenamento, execute o comando ibmcloud sat storage template get``.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--template-name
Especifique o nome do modelo de configuração de armazenamento do Satellite. Para listar os modelos de configuração de armazenamento disponíveis, execute o comando ibmcloud sat storage template ls``.
--template-version
Especifique a versão do modelo de configuração de armazenamento do Satellite. Se você não incluir essa opção, a versão padrão será usada. Para listar os modelos de configuração de armazenamento disponíveis, execute o comando ibmcloud sat storage template ls``.

Exemplos

Crie uma configuração de armazenamento do tipo “ Satellite ” para instalar drivers de armazenamento em seus clusters

ibmcloud sat storage config create --location LOCATION --name NAME --template-name NAME

ibmcloud sat storage config get

Satellite

Obter os detalhes de uma configuração de armazenamento do Satellite.

ibmcloud sat storage config get --config CONFIG [--output OUTPUT] [-q]

Opções de comando

--config
Especifique o nome ou ID de uma configuração de armazenamento do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat storage config ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Obter os detalhes de uma configuração de armazenamento do Satellite

ibmcloud sat storage config get --config CONFIG

ibmcloud sat storage config help

Mostrar ajuda

ibmcloud sat storage config help

Exemplos

Mostrar ajuda

ibmcloud sat storage config help

ibmcloud sat storage config ls

Satellite

Listar as configurações de armazenamento do Satellite em sua conta da IBM Cloud.

ibmcloud sat storage config ls [--location LOCATION] [--output OUTPUT] [-q]

Opções de comando

--location
Especifique o ID ou nome do local que contém as configurações que deseja listar. Para encontrar locais disponíveis, acesse ibmcloud sat location ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Liste as configurações de armazenamento do Satellite na sua conta IBM Cloud

ibmcloud sat storage config ls

ibmcloud sat storage config param help

Mostrar ajuda

ibmcloud sat storage config param help

Exemplos

Mostrar ajuda

ibmcloud sat storage config param help

ibmcloud sat storage config param set

Satellite

Defina os parâmetros de configuração e segredo de uma configuração de armazenamento do Satellite.

ibmcloud sat storage config param set --config CONFIG --param PARAM [--param PARAM ...] [--apply] [-f] [-q]

Opções de comando

--apply
Aplique a versão de configuração de armazenamento Satellite mais recente em todas as designações de uma configuração. Para listar as atribuições de uma configuração, execute o comando ibmcloud sat storage assignment ls --config CONFIG``.
--config
Especifique o nome ou ID da configuração de armazenamento. Para listar as configurações de armazenamen Satellite, execute o comando ibmcloud sat storage config ls``.
-f
Force o comando a ser executado sem prompts do usuário.
-p, --param
Especifique um par “ key=value ” para os parâmetros de configuração. Para visualizar os parâmetros de configuração de um modelo de armazenamento, execute o comando ibmcloud sat storage template get``.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Definir os parâmetros de configuração e os parâmetros secretos de uma configuração de armazenamento do Satellite

ibmcloud sat storage config param set --config CONFIG --param PARAM

ibmcloud sat storage config patch

Satellite

Aplique as atualizações de patch mais recentes a uma configuração de armazenamento do Satellite. As atualizações de correção contêm correções de vulnerabilidade e correções de erros na mesma versão principal.

ibmcloud sat storage config patch --config CONFIG [-f] [--include-assignments] [-q]

Aliases: ibmcloud sat upgrade

Opções de comando

--config
Especifique o nome ou ID de uma configuração de armazenamento do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat storage config ls.
-f
Force o comando a ser executado sem prompts do usuário.
--include-assignments
Inclua esta opção para atualizar as atribuições da configuração de armazenamento para a versão mais recente da configuração.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Aplique as atualizações de patch mais recentes a uma configuração de armazenamento do Satellite

ibmcloud sat storage config patch --config CONFIG

ibmcloud sat storage config rm

Satellite

Remover uma configuração de armazenamento do Satellite.

ibmcloud sat storage config rm --config CONFIG [-f] [--include-assignments] [-q]

Opções de comando

--config
Especifique o nome ou ID de uma configuração de armazenamento do Satellite. Para listar as configurações disponíveis, execute ibmcloud sat storage config ls.
-f
Force o comando a ser executado sem prompts do usuário.
--include-assignments
Inclua essa opção para remover a configuração de armazenamento e quaisquer designações associadas.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Remover uma configuração de armazenamento do Satellite

ibmcloud sat storage config rm --config CONFIG

ibmcloud sat storage help

Mostrar ajuda

ibmcloud sat storage help

Exemplos

Mostrar ajuda

ibmcloud sat storage help

ibmcloud sat storage template get

Satellite

Obtenha os detalhes de um modelo de armazenamento do Satellite

ibmcloud sat storage template get --name NAME --version VERSION [--output OUTPUT] [-q]

Opções de comando

--name
Especifique o nome do modelo de armazenamento. Para listar os modelos de armazenamento disponíveis, execute o comando ibmcloud sat storage template ls``.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--version
Especifique a versão do modelo de armazenamento. Para listar os modelos de armazenamento disponíveis, execute o comando ibmcloud sat storage template ls``.

Exemplos

Obtenha os detalhes de um modelo de armazenamento do Satellite

ibmcloud sat storage template get --name NAME --version VERSION

ibmcloud sat storage template help

Mostrar ajuda

ibmcloud sat storage template help

Exemplos

Mostrar ajuda

ibmcloud sat storage template help

ibmcloud sat storage template ls

Satellite

Liste os modelos de armazenamento disponíveis do Satellite.

ibmcloud sat storage template ls [-q]

Opções de comando

-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar os modelos de armazenamento disponíveis no Satellite

ibmcloud sat storage template ls

Comandos de assinatura

Visualizar e gerenciar assinaturas do Satellite para implementar arquivos de configuração do Kubernetes em seus clusters.

ibmcloud sat subscription create

Satellite

Crie uma assinatura do Satellite para clusters. Depois de criar a assinatura, a versão de configuração do Satellite associada é implementada automaticamente para os clusters assinados.

ibmcloud sat subscription create --config CONFIG --group GROUP [--group GROUP ...] --name NAME [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)

Opções de comando

--auth-required
Forneça o segredo de autenticação necessário para conectar ao repositório remoto. Consulte https://ibm.biz/sat-config-private-repo para obter detalhes. Estratégia: GitOps.
--config
Especifique o nome da configuração para usar para a assinatura. Para verificar as configurações disponíveis, acesse ibmcloud sat config ls.
-g, --group
Especifique o nome ou ID dos grupos de clusters para assinar sua configuração. Para encontrar os grupos de clusters disponíveis, execute o comando ibmcloud sat group ls``.
--gitref
Especifique o GitRef para usar para a assinatura do Satellite. Estratégia: GitOps.
--gitref-type
Indique o tipo de GitRef a ser usado para a assinatura do Satellite. Estratégia: GitOps. Valores permitidos: branch, commit, tag, release
--name
Insira um nome para a assinatura.
--path
Forneça o caminho para os arquivos de repositório ou ativos de liberação no repositório remoto a serem usados para a assinatura do Satellite. Estratégia: GitOps.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--repository
Especifique a URL do repositório remoto a ser usado para a assinatura. Estratégia: GitOps.
--version
Indique o nome ou ID da versão de configuração existente para usar para a assinatura. Para encontrar as versões, acesse ibmcloud sat config get --config <configuration_name_or_ID>. Estratégia: upload direto.

Exemplos

Criar uma assinatura do Satellite para clusters

ibmcloud sat subscription create \
  --config CONFIG \
  --group GROUP \
  --name NAME \
  --auth-required \
  --gitref GITREF \
  --gitref-type TYPE \
  --path PATH \
  --repository REPOSITORY

ibmcloud sat subscription get

Satellite

Obtenha informações detalhadas para uma assinatura do Satellite.

ibmcloud sat subscription get --subscription SUBSCRIPTION [--output OUTPUT] [-q]

Opções de comando

--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--subscription
Digite o nome ou o ID de uma assinatura do Satellite. Para localizar assinaturas, execute o comando ibmcloud sat subscription ls``.

Exemplos

Obtenha informações detalhadas sobre a assinatura do Satellite

ibmcloud sat subscription get --subscription SUBSCRIPTION

ibmcloud sat subscription help

Mostrar ajuda

ibmcloud sat subscription help

Exemplos

Mostrar ajuda

ibmcloud sat subscription help

ibmcloud sat subscription identity help

Mostrar ajuda

ibmcloud sat subscription identity help

Exemplos

Mostrar ajuda

ibmcloud sat subscription identity help

ibmcloud sat subscription identity set

Satellite

Atualize a assinatura do Satellite para usar sua identidade no gerenciamento de recursos.

ibmcloud sat subscription identity set --subscription SUBSCRIPTION [-f] [-q]

Opções de comando

-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--subscription
Especifique o nome ou ID de uma assinatura do Satellite. Para listar as assinaturas, execute o comando ibmcloud sat subscription ls``.

Exemplos

Atualize a assinatura do Satellite para usar sua identidade no gerenciamento de recursos

ibmcloud sat subscription identity set --subscription SUBSCRIPTION

ibmcloud sat subscription ls

Satellite

Liste todas as assinaturas do Satellite em sua conta do IBM Cloud.

ibmcloud sat subscription ls [--cluster CLUSTER] [--output OUTPUT] [-q]

Opções de comando

-c, --cluster
Especifique o nome do cluster ou ID do Satellite. Para localizar clusters registrados, acesse ibmcloud sat cluster ls.
--output
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Exemplos

Listar todas as assinaturas do Satellite na sua conta do IBM Cloud

ibmcloud sat subscription ls

ibmcloud sat subscription rm

Satellite

Remova uma assinatura do Satellite. Os recursos do Kubernetes não são mais implementados em seus clusters.

ibmcloud sat subscription rm --subscription SUBSCRIPTION [-f] [-q]

Opções de comando

-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--subscription
Forneça o nome ou ID de uma assinatura do Satellite. Para listar as assinaturas, execute o comando ibmcloud sat subscription ls``.

Exemplos

Cancelar uma assinatura do “ Satellite ”

ibmcloud sat subscription rm --subscription SUBSCRIPTION

ibmcloud sat subscription update

Satellite

Atualize uma assinatura do Satellite.

ibmcloud sat subscription update --subscription SUBSCRIPTION [-f] [--group GROUP] [--name NAME] [-q] (--auth-required --gitref GITREF --gitref-type TYPE --path PATH --repository REPOSITORY | --version VERSION)

Opções de comando

--auth-required
Forneça o segredo de autenticação necessário para conectar ao repositório remoto. Estratégia: GitOps.
-f
Force o comando a ser executado sem prompts do usuário.
-g, --group
Especifique os novos grupos de clusters para assinar sua configuração.
--gitref
Especifique o GitRef para usar para a assinatura do Satellite. Estratégia: GitOps.
--gitref-type
Indique o tipo de GitRef a ser usado para esta assinatura do Satellite. Estratégia: GitOps. Valores permitidos: branch, commit, tag, release
--name
Forneça um novo nome da assinatura do Satellite.
--path
Indique o caminho para os arquivos de repositório ou ativos de liberação no repositório remoto a ser usado para a assinatura do Satellite. Estratégia: GitOps.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--repository
Forneça a URL do repositório remoto para usar para a assinatura do Satellite. Estratégia: GitOps.
--subscription
Especifique o nome ou ID de uma assinatura do Satellite. Para listar as assinaturas, execute o comando ibmcloud sat subscription ls``.
--version
Indique a versão de configuração existente a ser usada para a assinatura do Satellite. Estratégia: upload direto.

Exemplos

Atualizar uma assinatura do “ Satellite ”

ibmcloud sat subscription update \
  --subscription SUBSCRIPTION \
  --auth-required \
  --gitref GITREF \
  --gitref-type TYPE \
  --path PATH \
  --repository REPOSITORY