Référence d'interface de ligne de commande des commandes Satellite

Reportez-vous à ces commandes CLI d' Satellite lorsque vous souhaitez automatiser la création et la gestion de votre emplacement Satellite, y compris les opérations relatives à l'emplacement, à l'hôte, au cluster et aux points de terminaison.

Pour installer l'interface de ligne de commande, voir Installation de l'interface de ligne de commande. Pour afficher une carte de haut niveau de toutes les commandes IBM Cloud Satellite, voir la carte CLI.

  1. Installez l'interface de ligne de commande IBM Cloud. Voir Initiation à l'interface de ligne de commande IBM Cloud.

  2. Installez le plug-in ks.

    ibmcloud plugin install ks
    

Commandes Acl

Afficher et gérer les listes de contrôle d'accès (ACL) d' Satellite.

ibmcloud sat acl create

Satellite

Créez une liste de contrôle d'accès.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Nom ou ID d'un terminal à activer pour cet ACL.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--name
Nom de la liste de contrôle d'accès (ACL).
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--subnet
Un bloc IP ou CIDR autorisé par cette ACL. La valeur doit être entièrement comprise dans les CIDR suivants : 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Exemples

Créer une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl endpoint add

Satellite

Ajouter un ou plusieurs points d'extrémité activés à une liste de contrôle d'accès.

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Nom ou ID d'un terminal à activer pour cet ACL.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Ajouter un ou plusieurs points de terminaison activés à une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl endpoint help

Afficher l'aide

ibmcloud sat acl endpoint help

Exemples

Afficher l'aide

ibmcloud sat acl endpoint help

ibmcloud sat acl endpoint ls

Satellite

Liste de tous les points d'extrémité activés pour un ACL.

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier tous les points de terminaison activés pour une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl endpoint rm

Satellite

Supprimer un ou plusieurs points de terminaison activés d'une liste de contrôle d'accès (ACL).

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Nom ou ID d'un terminal à désactiver pour cet ACL.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer un ou plusieurs points de terminaison activés d'une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl get

Satellite

Afficher les détails d'une liste de contrôle d'accès (ACL).

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Afficher les détails d'une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl help

Afficher l'aide

ibmcloud sat acl help

Exemples

Afficher l'aide

ibmcloud sat acl help

ibmcloud sat acl ls

Satellite

Répertorier toutes les listes de contrôle d'accès (ACL) pour un connecteur ou un emplacement d' Satellite.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier toutes les listes de contrôle d'accès (ACL) pour un connecteur ou un emplacement d' Satellite

ibmcloud sat acl ls --connector-id ID

ibmcloud sat acl rm

Satellite

Supprimer une ACL.

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl subnet add

Satellite

Ajouter un ou plusieurs sous-réseaux à une liste de contrôle d'accès (ACL).

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--subnet
Un bloc IP ou CIDR autorisé par cette ACL. La valeur doit être entièrement comprise dans les CIDR suivants : 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Exemples

Ajouter un ou plusieurs sous-réseaux à une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl subnet help

Afficher l'aide

ibmcloud sat acl subnet help

Exemples

Afficher l'aide

ibmcloud sat acl subnet help

ibmcloud sat acl subnet rm

Satellite

Supprimer un ou plusieurs sous-réseaux d'une liste de contrôle d'accès.

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--subnet
Un bloc IP ou CIDR autorisé par cette ACL. La valeur doit être entièrement comprise dans les CIDR suivants : 10.0.0.0/8, 161.26.0.0/16, 166.8.0.0/14, 172.16.0.0/12.

Exemples

Supprimer un ou plusieurs sous-réseaux d'une liste de contrôle d'accès (ACL)

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

ibmcloud sat acl update

Satellite

Mettre à jour le nom d'un ACL.

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

Options de commande

--acl-id
Spécifiez l'ID de l'ACL. Pour lister toutes les ACL, exécutez ibmcloud sat acl ls.
--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--name
Le nouveau nom de l'ACL.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Mettre à jour le nom d'une liste ACL

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

Commandes d'agent

Ajouter ou consulter les agents du connecteur « Satellite ».

ibmcloud sat agent attach

Satellite

Obtenir un agent de connexion Satellite pour une plateforme spécifique. Téléchargez l'agent pour .zip Windows ou obtenez un lien vers la documentation relative aux environnements Docker.

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

Options de commande

--platform
La plate-forme de l'agent connecteur Satellite. Pour plus d'informations sur Docker, consultez la documentation à l'adresse https://ibm.biz/satconagent Options disponibles : windows, docker
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Obtenir un agent de connexion Satellite pour une plateforme spécifique

ibmcloud sat agent attach --platform PLATFORM

ibmcloud sat agent help

Afficher l'aide

ibmcloud sat agent help

Exemples

Afficher l'aide

ibmcloud sat agent help

ibmcloud sat agent ls

Satellite

Répertorier tous les agents d'un connecteur Satellite.

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

Options de commande

--connector-id
ID d'un connecteur Satellite.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier tous les agents d'un connecteur Satellite

ibmcloud sat agent ls --connector-id ID

Commandes de cluster

Enregistrez et gérez des clusters à utiliser avec les configurations Satellite.

ibmcloud sat cluster get

Virtual Private Cloud Classic infrastructure Satellite

Obtenez les détails d'un cluster enregistré.

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

Options de commande

-c, --cluster
Spécifiez l'ID ou le nom du cluster. Pour afficher la liste des clusters enregistrés, exécutez la commande ibmcloud sat cluster ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Obtenir les détails d'un cluster enregistré

ibmcloud sat cluster get --cluster CLUSTER

ibmcloud sat cluster help

Afficher l'aide

ibmcloud sat cluster help

Exemples

Afficher l'aide

ibmcloud sat cluster help

ibmcloud sat cluster ls

Virtual Private Cloud Classic infrastructure Satellite

Répertoriez tous les clusters enregistrés sur votre compte IBM Cloud.

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

Options de commande

--filter
Filtrez les clusters enregistrés par ID de cluster.
--limit
Permet de limiter le nombre de clusters renvoyés.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier tous les clusters enregistrés dans votre compte IBM Cloud

ibmcloud sat cluster ls

ibmcloud sat cluster register

Satellite

Obtenez une commande kubectl pour enregistrer votre cluster dans une configuration Satellite. Connectez-vous à votre cluster et exécutez cette commande pour installer un agent Satellite Config. Les clusters que vous exécutez dans votre emplacement Satellite installent automatiquement cet agent.

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

Options de commande

--name
Spécifiez le nom du cluster à enregistrer
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--silent
Mode silencieux. Renvoie uniquement la commande d'enregistrement dans la sortie.

Exemples

Obtenez une commande kubectl pour enregistrer votre cluster dans une configuration Satellite

ibmcloud sat cluster register --name NAME

ibmcloud sat cluster unregister

Satellite

Retirez un enregistrement de cluster. Le cluster n'est plus abonné à une configuration Satellite, mais le cluster et ses ressources existantes continuent de s'exécuter.

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

Options de commande

-c, --cluster
Spécifiez l'ID ou le nom du cluster. Pour afficher la liste des clusters enregistrés, exécutez la commande ibmcloud sat cluster ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer l'enregistrement d'un cluster

ibmcloud sat cluster unregister --cluster CLUSTER

Commandes de configuration

Affichez et gérez la configuration Satellite.

ibmcloud sat config create

Satellite

Créez une configuration pour spécifier les ressources Kubernetes à déployer dans vos clusters, dans vos charges de travail Satellite.

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

Options de commande

--data-location
Spécifiez la région IBM dans laquelle stocker les données de configuration Satellite. Stratégie : Transfert direct.
--name
Indiquez un nom pour la configuration Satellite.
--provider
Indiquez le fournisseur GitOps distant pour la configuration Satellite. Ce fournisseur stocke les définitions de ressource Kubernetes. Stratégie : GitOps. Valeurs autorisées: github, gitlab
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Créez une configuration pour spécifier les ressources d' Kubernetes que vous souhaitez déployer sur vos clusters dans vos charges de travail Satellite

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

ibmcloud sat config get

Satellite

Obtenez les détails d'une configuration Satellite, par exemple les versions ou les abonnements associés à la configuration.

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

Options de commande

--config
Spécifiez le nom ou l'ID d'une configuration Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat config ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Obtenez des détails sur une configuration d' Satellite, tels que les versions ou les abonnements associés à cette configuration

ibmcloud sat config get --config CONFIG

ibmcloud sat config help

Afficher l'aide

ibmcloud sat config help

Exemples

Afficher l'aide

ibmcloud sat config help

ibmcloud sat config ls

Satellite

Répertoriez toutes les configurations Satellite dans votre compte IBM Cloud.

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

Options de commande

--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertoriez toutes les configurations d' Satellite s dans votre compte IBM Cloud

ibmcloud sat config ls

ibmcloud sat config rename

Satellite

Renommez une configuration Satellite.

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

Options de commande

--config
Spécifiez le nom ou l'ID d'une configuration Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat config ls.
--name
Indiquez un nouveau nom pour la configuration Satellite.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Renommer une configuration d' Satellite

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

ibmcloud sat config rm

Satellite

Retirez une configuration Satellite. Vous devez d'abord retirer tous les abonnements associés. Toutes les versions sont supprimées. Effectuez une sauvegarde des définitions de ressource que vous voulez conserver.

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

Options de commande

--config
Spécifiez le nom ou l'ID d'une configuration Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat config ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer une configuration d’ Satellite

ibmcloud sat config rm --config CONFIG

ibmcloud sat config version create

Satellite

Créez une version de configuration pour mettre à jour les ressources Kubernetes existantes pour vos charges de travail Satellite.

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

Options de commande

--config
Spécifiez le nom ou l'ID de la configuration Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat config ls.
--description
Ajoutez une description de la version de configuration Satellite.
--file-format
Indiquez le format de fichier de la version de configuration. Options disponibles: yaml
--name
Indiquez un nom pour la version de configuration Satellite.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--read-config
Spécifiez le chemin d'accès au fichier de version de configuration.

Exemples

Créez une version de configuration pour mettre à jour les ressources existantes d' Kubernetes. pour vos charges de travail Satellite

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

ibmcloud sat config version get

Satellite

Obtenez de détails sur une version de configuration Satellite.

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

Options de commande

--config
Spécifiez le nom ou l'ID de la configuration Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat config ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--save-config
Téléchargez et sauvegardez la version de configuration dans un fichier temporaire.
--version
Spécifiez le nom ou l'ID de la version de configuration Satellite. Pour afficher la liste des versions de votre configuration, exécutez ibmcloud sat config get --config <configuration_name_or_ID>.

Exemples

Obtenir des détails sur une version de configuration d' Satellite

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

ibmcloud sat config version help

Afficher l'aide

ibmcloud sat config version help

Exemples

Afficher l'aide

ibmcloud sat config version help

ibmcloud sat config version rm

Satellite

Retirez une version de configuration Satellite.

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

Options de commande

--config
Spécifiez le nom ou l'ID de la configuration Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat config ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--version
Indiquez le nom ou l'ID de la version de configuration Satellite. Pour afficher la liste des versions, exécutez ibmcloud sat config get --config <configuration_name_or_ID>.

Exemples

Supprimer une version de configuration d' Satellite

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

Commandes du connecteur

Créez, affichez et modifiez des connecteurs Satellite.

ibmcloud sat connector create

Satellite

Créez un connecteur Satellite.

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

Options de commande

--name
Nom du connecteur Satellite.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--region
Région IBM Cloud pour la gestion de votre connecteur Satellite.

Exemples

Créer un connecteur Satellite

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

ibmcloud sat connector get

Satellite

Affichez les détails d'un connecteur Satellite.

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

Options de commande

--connector-id
ID d'un connecteur Satellite.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Consulter les détails d’un connecteur Satellite

ibmcloud sat connector get --connector-id ID

ibmcloud sat connector help

Afficher l'aide

ibmcloud sat connector help

Exemples

Afficher l'aide

ibmcloud sat connector help

ibmcloud sat connector ls

Satellite

Consultez les connecteurs Satellite dans votre compte IBM Cloud.

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

Options de commande

--after
Afficher les connecteurs Satellite après le curseur donné.
--first
Visualiser les connecteurs suivants Satellite, jusqu'au premier nombre de connecteurs.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Consultez les connecteurs Satellite dans votre compte IBM Cloud

ibmcloud sat connector ls

ibmcloud sat connector rm

Satellite

Supprimez un connecteur Satellite.

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

Options de commande

--connector-id
ID d'un connecteur Satellite.
-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer un connecteur d' Satellite

ibmcloud sat connector rm --connector-id ID

Commandes de noeud final

Affichez et gérez les noeuds finaux Satellite.

ibmcloud sat endpoint authn get

Satellite

Obtenir les paramètres d'authentification d'un point d'accès.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Récupérer les paramètres d'authentification d'un point de terminaison

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

ibmcloud sat endpoint authn help

Afficher l'aide

ibmcloud sat endpoint authn help

Exemples

Afficher l'aide

ibmcloud sat endpoint authn help

ibmcloud sat endpoint authn rotate

Satellite

Remplacer les certificats d'authentification existants par de nouveaux. Le flux de requêtes comporte deux connexions TLS. Ces options source font référence à la négociation de connexion TLS entre la source et le service Connector. Ces options destination font référence à la négociation de connexion TLS e entre le service Connector et votre serveur de destination. Vous pouvez fournir des certificats pour l'une de ces connexions ou les deux. Seuls les certificats que vous spécifiez sont remplacés.

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)

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--dest-ca-cert-file
Certificat ou chaîne de l'autorité de certification digne de confiance utilisé pour valider le certificat du serveur de destination. Par exemple,myCA.pem.
--dest-cert-file
Le certificat client utilisé pour s'authentifier auprès du serveur de destination. Par exemple,myCert.pem.
--dest-key-file
Clé privée du client utilisée pour chiffrer le certificat client. Par exemple,myKey.pem.
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--source-ca-cert-file
Certificat ou chaîne de l'autorité de certification digne de confiance utilisé pour valider le certificat du client source lorsque le mode source-tls-mode est mutuel. Par exemple,myCA.pem.
--source-cert-file
Certificat serveur à présenter au client source. Par exemple,myCert.pem.
--source-key-file
Clé privée du serveur utilisée pour chiffrer le certificat du serveur. Par exemple,myKey.pem.

Exemples

Remplacer les certificats d'authentification existants par de nouveaux

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

ibmcloud sat endpoint authn set

Satellite

Définir les paramètres d'authentification pour un point d'extrémité. Le flux de requêtes comporte deux connexions TLS. Ces options source font référence à la négociation de connexion TLS entre la source et le service Connector. Ces options destination font référence à la négociation de connexion TLS e entre le service Connector et votre serveur de destination. Vous pouvez fournir des certificats pour l'une de ces connexions ou les deux. Les paramètres non spécifiés sont définis sur leurs valeurs par défaut.

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)

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--dest-ca-cert-file
Certificat ou chaîne de l'autorité de certification digne de confiance utilisé pour valider le certificat du serveur de destination. Par exemple,myCA.pem.
--dest-cert-file
Le certificat client utilisé pour s'authentifier auprès du serveur de destination. Par exemple,myCert.pem.
--dest-key-file
Clé privée du client utilisée pour chiffrer le certificat client. Par exemple,myKey.pem.
--dest-tls-mode
Le mode de destination TLS. Valeurs acceptées :simple,mutual,none
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--source-ca-cert-file
Certificat ou chaîne de l'autorité de certification digne de confiance utilisé pour valider le certificat du client source lorsque le mode source-tls-mode est mutuel. Par exemple,myCA.pem.
--source-cert-file
Certificat serveur à présenter au client source. Par exemple,myCert.pem.
--source-key-file
Clé privée du serveur utilisée pour chiffrer le certificat du serveur. Par exemple,myKey.pem.
--source-tls-mode
Mode « source- TLS ». Valeurs acceptées: simple, mutual

Exemples

Configurer les paramètres d'authentification d'un point de terminaison

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

ibmcloud sat endpoint create

Satellite

Créez un noeud final.

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)

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--dest-hostname
Indiquez le nom de domaine complet ou l'adresse IP accessible en externe de la destination à laquelle vous voulez vous connecter. Pour les points cloud de terminaison, cette valeur doit correspondre à une adresse IP publique ou à une adresse IP privée accessible au sein d’ IBM Cloud, comme un point de terminaison de service cloud privé. Pour les points location de terminaison, cette valeur doit pouvoir être résolue et être accessible depuis les hôtes du plan de contrôle pour les emplacements Satellite ou depuis l’endroit où l’agent s’exécute pour le connecteur Satellite.
--dest-port
Indiquez le port sur lequel la ressource de destination est à l'écoute des demandes entrantes. Assurez-vous que le port correspond au protocole de destination.
--dest-protocol
Spécifiez le protocole de la destination. Si vous ne spécifiez pas cette option, le protocole de destination est hérité du protocole source. Valeurs acceptées: TCP, TLS
--dest-type
Précisez où la ressource de destination s'exécute, soit dans IBM Cloud (cloud) soit à votre emplacement Satellite (location). Options disponibles : emplacement, cloud
--idle-timeout-seconds
Indiquez le délai d'attente en secondes pour les connexions actives à la destination. Vérifiez que votre délai d'attente est compatible avec les paramètres du service de destination et du protocole keep-alive.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--name
Indiquez un nom pour le noeud final.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--sni
Spécifiez l'indicateur de nom de serveur si vous indiquez un protocole source https ou tls et que vous souhaitez qu'un nom d'hôte distinct soit ajouté à la négociation de connexion TLS.
--source-protocol
Indiquez le protocole utilisé par la source pour connecter la ressource de destination. Voir http://ibm.biz/endpoint-protocols. Options disponibles : TCP, TLS, HTTP, HTTPS, HTTP-tunnel

Exemples

Créer un noeud final

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

Désactiver un point d'extrémité.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).
-f
Force la commande à s'exécuter sans invites utilisateur.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Désactiver un point de terminaison

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

ibmcloud sat endpoint enable

Satellite

Activer un point d'extrémité.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).
-f
Force la commande à s'exécuter sans invites utilisateur.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Activer un point de terminaison

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

ibmcloud sat endpoint get

Satellite

Permet d'afficher les détails d'un noeud final.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Afficher les détails d'un point de terminaison

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

ibmcloud sat endpoint help

Afficher l'aide

ibmcloud sat endpoint help

Exemples

Afficher l'aide

ibmcloud sat endpoint help

ibmcloud sat endpoint ls

Satellite

Répertoriez tous les noeuds finaux se trouvant dans un emplacement Satellite.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier tous les points de terminaison d'un emplacement Satellite

ibmcloud sat endpoint ls --connector-id ID

ibmcloud sat endpoint rm

Satellite

Supprimez un noeud final.

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

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer un point de terminaison

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

ibmcloud sat endpoint update

Satellite

Mettez à jour un noeud final. Seules les options que vous spécifiez sont mises à jour.

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)

Options de commande

--connector-id
L'identifiant du connecteur Satellite. Pour trouver l'ID de connecteur, exécutez ibmcloud sat connector ls.
--dest-hostname
Indiquez le nom de domaine complet ou l'adresse IP accessible en externe de la destination à laquelle vous voulez vous connecter. Pour les points cloud de terminaison, cette valeur doit correspondre à une adresse IP publique ou à une adresse IP privée accessible au sein d’ IBM Cloud, comme un point de terminaison de service cloud privé. Pour les points location de terminaison, cette valeur doit pouvoir être résolue et être accessible depuis les hôtes du plan de contrôle pour les emplacements Satellite ou depuis l’endroit où l’agent s’exécute pour le connecteur Satellite.
--dest-port
Indiquez le port sur lequel la ressource de destination est à l'écoute des demandes entrantes. Assurez-vous que le port correspond au protocole de destination.
--dest-protocol
Spécifiez le protocole de la destination. Si vous ne spécifiez pas cette option, le protocole de destination est hérité du protocole source. Valeurs acceptées: TCP, TLS
--endpoint
Spécifiez le nom ou l'ID du noeud final. Pour répertorier tous les points de terminaison, exécutez ibmcloud sat endpoint ls (--connector-id ID | --location LOCATION).
--idle-timeout-seconds
Indiquez le délai d'attente en secondes pour les connexions actives à la destination. Vérifiez que votre délai d'attente est compatible avec les paramètres du service de destination et du protocole keep-alive.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--name
Indiquez un nouveau nom pour le noeud final.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--sni
Spécifiez l'indicateur de nom de serveur si vous indiquez un protocole source https ou tls et que vous souhaitez qu'un nom d'hôte distinct soit ajouté à la négociation de connexion TLS.
--source-protocol
Indiquez le protocole utilisé par la source pour connecter la ressource de destination. Voir http://ibm.biz/endpoint-protocols. Valeurs autorisées : TCP, TLS, HTTP, HTTPS, HTTP-tunnel

Exemples

Mettre à jour un point de terminaison

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

Commandes expérimentales

[Expires on 2024-11-25] Testez de nouvelles commandes. IMPORTANT : les commandes mentionnées ici seront supprimées après la date indiquée dans [date] leur description.

ibmcloud sat experimental endpoint help

Afficher l'aide

ibmcloud sat experimental endpoint help

Exemples

Afficher l'aide

ibmcloud sat experimental endpoint help

ibmcloud sat experimental help

Afficher l'aide

ibmcloud sat experimental help

Exemples

Afficher l'aide

ibmcloud sat experimental help

Commandes GROUP

Affichez et gérez les groupes de clusters Satellite. Les groupes de clusters sont utilisés pour abonner des clusters aux configurations Satellite des ressources Kubernetes.

ibmcloud sat group attach

Satellite

Ajoutez un cluster à votre groupe de clusters. Le cluster peut s'exécuter dans votre emplacement Satellite ou dans IBM Cloud. Pour ajouter un cluster qui s'exécute dans IBM Cloud, vous devez d'abord enregistrer le cluster auprès de Satellite Config.

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

Options de commande

-c, --cluster
Spécifier le nom ou l'ID du cluster. Pour afficher la liste des clusters enregistrés, exécutez la commande ibmcloud sat cluster ls.
-g, --group
Spécifiez le nom ou l'ID d'un groupe de clusters Satellite. Pour afficher les groupes de clusters disponibles, exécutez ibmcloud sat group ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Ajouter un cluster à votre groupe de clusters

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

ibmcloud sat group create

Satellite

créez un groupe de clusters. Vous pouvez ensuite abonner le groupe de clusters à une configuration Satellite.

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

Options de commande

-c, --cluster
Spécifiez l'ID ou le nom de cluster à ajouter au groupe de clusters. Pour afficher la liste des clusters enregistrés, exécutez la commande ibmcloud sat cluster ls.
--name
Indiquez un nom pour le groupe de clusters Satellite.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Créer un groupe de clusters

ibmcloud sat group create --name NAME

ibmcloud sat group detach

Satellite

Retire un ou plusieurs clusters de votre groupe de clusters Satellite et supprime les ressources Kubernetes gérées par les abonnements du groupe.

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

Options de commande

-c, --cluster
Spécifier le nom ou l'ID du cluster. Pour répertorier les clusters de votre groupe de clusters, exécutez la commande ibmcloud sat group get --group <cluster_group_name_or_ID>.
-f
Force la commande à s'exécuter sans invites utilisateur.
-g, --group
Spécifiez le nom ou l'ID d'un groupe de clusters Satellite. Pour afficher les groupes de clusters disponibles, exécutez ibmcloud sat group ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprime un ou plusieurs clusters de votre groupe de clusters Satellite et supprime les ressources Kubernetes qui étaient gérées par les abonnements du groupe

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

ibmcloud sat group get

Satellite

Obtenez des informations détaillées sur un groupe de clusters Satellite.

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

Options de commande

-g, --group
Spécifiez le nom ou l'ID d'un groupe de clusters Satellite. Pour afficher la liste des clusters enregistrés, exécutez la commande ibmcloud sat cluster ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Obtenir des informations détaillées sur un groupe de clusters d' Satellite

ibmcloud sat group get --group GROUP

ibmcloud sat group help

Afficher l'aide

ibmcloud sat group help

Exemples

Afficher l'aide

ibmcloud sat group help

ibmcloud sat group ls

Satellite

Répertoriez tous les groupes de clusters Satellite dans votre compte IBM Cloud.

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

Options de commande

--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier tous les groupes de clusters d' Satellite s dans votre compte IBM Cloud

ibmcloud sat group ls

ibmcloud sat group rm

Satellite

Retirez un groupe de clusters Satellite, ce qui désabonne les clusters et supprime les ressources Kubernetes gérées par les abonnements du groupe.

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

Options de commande

-f
Force la commande à s'exécuter sans invites utilisateur.
-g, --group
Spécifiez le nom ou l'ID d'un groupe de clusters Satellite. Pour afficher les groupes de clusters disponibles, exécutez ibmcloud sat group ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer un groupe de clusters Satellite, ce qui désabonne les clusters et supprime les ressources Kubernetes gérées par les abonnements du groupe

ibmcloud sat group rm --group GROUP

Commandes d'hôte

Affichez et modifiez des hôtes Satellite.

ibmcloud sat host assign

Satellite

Affectez un hôte à un cluster ou à un plan de contrôle d'emplacement Satellite.

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

Options de commande

--cluster
Nom ou ID du cluster auquel affecter l'hôte. Pour répertorier les clusters disponibles, exécutez ibmcloud sat cluster ls. Si aucun cluster n'est fourni, l'hôte est automatiquement affecté au plan de contrôle Satellite.
--host
Nom ou ID de l'hôte à affecter. Pour affecter automatiquement des hôtes en fonction de libellés, n'incluez pas cette option. Pour extraire l'ID de l'hôte, exécutez ibmcloud sat host ls --location <location_ID_or_name>.
--host-label, --hl
Saisissez les étiquettes sous forme de paires clé-valeur afin d’identifier l’hôte à attribuer à votre plan de contrôle Satellite ou à votre cluster Red Hat OpenShift. Le premier hôte associé à ce libellé et qui n'est pas affecté est affecté automatiquement au plan de contrôle ou au cluster. Pour rechercher les libellés d'hôte disponibles, exécutez ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-p, --worker-pool
Nom ou ID du pool de noeuds worker du cluster auquel affecter l'hôte. Si aucun pool de noeuds worker n'est spécifié, l'hôte est affecté au pool de noeuds worker par défaut.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--zone
Nom ou ID de la zone auquel affecter l'hôte. Pour connaître les zones disponibles, exécutez ibmcloud sat location get --location <location_name_or_ID> et recherchez le champ Host Zones.

Exemples

Attribuer un hôte à un plan de contrôle de localisation ou à un cluster d' Satellite

ibmcloud sat host assign --location LOCATION

ibmcloud sat host attach

Satellite

Créez et téléchargez un script que vous pouvez exécuter sur vos hôtes pour les connecter à votre emplacement. Pour les emplacements pour lesquels RHCOS est activé, le script est un fichier ignition.

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

Options de commande

--host-label, --hl
Saisissez les étiquettes sous forme de paires clé-valeur afin d’identifier l’hôte à attribuer à votre plan de contrôle Satellite ou à votre cluster Red Hat OpenShift. Le premier hôte associé à ce libellé et qui n'est pas affecté est affecté automatiquement au plan de contrôle ou au cluster. Pour rechercher les libellés d'hôte disponibles, exécutez ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.
--host-link-agent-endpoint
Noeud final utilisé par l'agent de liaison pour se connecter au serveur de tunnel de liaison.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--operating-system
Système d'exploitation des hôtes que vous souhaitez connecter à votre emplacement. Pour que vous puissiez connecter des hôtes RHCOS, RHCOS doit être activé pour votre emplacement. Valeurs acceptées: RHEL, RHCOS
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--reset-key
Réinitialisez la clé utilisée par le plan de contrôle pour connecter et attribuer des hôtes dans l'emplacement. Voir https://ibm.biz/reset-key.

Exemples

Créez et téléchargez un script que vous pouvez exécuter sur vos hôtes afin de les associer à votre emplacement

ibmcloud sat host attach --location LOCATION

ibmcloud sat host get

Satellite

Affichez les détails d'un hôte Satellite.

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

Options de commande

--host
ID de l'hôte Satellite. Pour trouver l'ID de l'hôte, exécutez ibmcloud sat host ls <location_ID_or_name>.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Afficher les détails d'un hôte Satellite

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

ibmcloud sat host help

Afficher l'aide

ibmcloud sat host help

Exemples

Afficher l'aide

ibmcloud sat host help

ibmcloud sat host ls

Satellite

Répertoriez tous les hôtes associés à un emplacement Satellite, notamment les hôtes affectés aux clusters ou au plan de contrôle.

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

Options de commande

--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertoriez tous les hôtes associés à un emplacement Satellite, y compris ceux affectés à des clusters ou au plan de contrôle

ibmcloud sat host ls --location LOCATION

ibmcloud sat host rm

Satellite

Retirez un hôte d'un emplacement Satellite.

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

Options de commande

-f
Force la commande à s'exécuter sans invites utilisateur.
--host
Nom ou ID de l'hôte à retirer.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer un hôte d'un emplacement Satellite

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

ibmcloud sat host update

Satellite

Mettez à jour les informations d'hôte, telles que les zones et les libellés.

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

Options de commande

--host
Nom ou ID de l'hôte à affecter. Pour affecter automatiquement des hôtes en fonction de libellés, n'incluez pas cette option.
--host-label, --hl
Saisissez les étiquettes sous forme de paires clé-valeur afin d’identifier l’hôte à attribuer à votre plan de contrôle Satellite ou à votre cluster Red Hat OpenShift. Le premier hôte associé à ce libellé et qui n'est pas affecté est affecté automatiquement au plan de contrôle ou au cluster. Pour rechercher les libellés d'hôte disponibles, exécutez ibmcloud sat host get --host <host_name_or_ID> --location <location_name_or_ID>.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--zone
Le nom ou l'ID de la zone à associer à l'hôte. Vous ne pouvez pas changer la zone des hôtes qui sont affectés à une ressource, par exemple un cluster. Vous devez d'abord annuler l'affectation des hôtes. Pour afficher la liste des zones disponibles, exécutez ibmcloud sat location get --location <ID>.

Exemples

Mettre à jour les informations relatives à l'hôte, telles que les zones et les étiquettes

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

Commandes clés

Affichez et gérez les clés Satellite Config.

ibmcloud sat key help

Afficher l'aide

ibmcloud sat key help

Exemples

Afficher l'aide

ibmcloud sat key help

ibmcloud sat key ls

Satellite

Répertoriez toutes les clés de configuration Satellite dans votre compte IBM Cloud.

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

Options de commande

--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertoriez toutes les clés de configuration d' Satellite s dans votre compte IBM Cloud

ibmcloud sat key ls

ibmcloud sat key rm

Satellite

Supprimez une clé Satellite Config. Les clusters qui utilisent encore cette clé ne peuvent pas se connecter à Satellite Config.

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

Options de commande

-f
Force la commande à s'exécuter sans invites utilisateur.
--key
Nom ou ID d'une clé Satellite Config.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer une clé de configuration d' Satellite

ibmcloud sat key rm --key KEY

ibmcloud sat key rotate

Satellite

Générez une nouvelle clé à utiliser par les clusters gérés pour vous connecter à Satellite Config.

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

Options de commande

-f
Force la commande à s'exécuter sans invites utilisateur.
--name
Nom de la nouvelle clé Satellite Config.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Générer une nouvelle clé destinée aux clusters gérés pour se connecter à la configuration d' Satellite

ibmcloud sat key rotate --name NAME

Commandes d'emplacement

Créez, affichez et modifiez les emplacements Satellite.

ibmcloud sat location create

Satellite

Créez un emplacement Satellite. Un emplacement Satellite est la représentation d'un environnement dans votre fournisseur d'infrastructure. Une fois que vous avez créé un emplacement, associez-y des hôtes provenant de zones distinctes de votre environnement d'infrastructure sous-jacente à l'aide de la commande 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]

Options de commande

--capability
Une fonctionnalité du site Satellite.
--coreos-enabled
Activez les fonctions Red Hat CoreOS pour l'emplacement Satellite. Cette action ne peut pas être annulée. Voir https://ibm.biz/infra-os.
--cos-bucket
Spécifiez le nom du compartiment IBM Cloud Object Storage dans lequel stocker vos données de plan de contrôle de l'emplacement Satellite. Autrement, un nouveau compartiment sera créé automatiquement.
--description
Entrez une description de l'emplacement Satellite.
--ha-zone
Spécifiez la zone pour votre emplacement. Pour garantir une haute disponibilité, spécifiez 3 zones pour votre emplacement comme suit : --ha-zone ZONE1_NAME --ha-zone ZONE2_NAME --ha-zone ZONE3_NAME. Les noms des zones doivent être exactement identiques aux noms des zones correspondantes dans le fournisseur d'infrastructure dans lequel vous prévoyez de créer des hôtes.
--managed-from
Sélectionnez la région IBM Cloud à partir de laquelle gérer votre emplacement Satellite. Choisissez une région proche de votre centre de données sur site pour de meilleures performances. Voir https://ibm.biz/sat-region.
--name
Spécifiez un nom pour l'emplacement Satellite. Les noms de lieux doivent commencer par une lettre, peuvent contenir des lettres, des chiffres, des points (.) et des tirets (-), et doivent comporter moins de 36 caractères. Ne réutilisez pas les noms, même si l'autre emplacement est supprimé.
--physical-address
L'adresse physique de l'emplacement du Satellite.
--pod-network-interface-selection
Méthode de sélection de l'interface réseau de noeud pour le réseau de pod interne. Cette option ne peut être utilisée que si vous activez également Red Hat CoreOS avec l'option --coreos-enabled. Pour fournir une adresse URL ou IP directe, spécifiez can-reach=<url> ou can-reach=<ip_address>. Pour choisir une interface réseau, spécifiez interface=<network_interface>.
--pod-subnet
Spécifiez un routage CIDR de sous-réseau personnalisé pour fournir les adresses IP privées des pods. Cette option n'est utilisée que si vous activez Red Hat CoreOS avec l'option --coreos-enabled. Le sous-réseau doit avoir une taille d'au /23 moins. Voir https://ibm.biz/sat-location-create. Valeur par défaut : '172.16.0.0/16
--provider
Indiquez le fournisseur d'infrastructure à utiliser pour l'emplacement Satellite. Si vous incluez cette option, vous devez également inclure l'option --provider-credential. Valeurs acceptées: aws, azure, gcp, vmware
--provider-credential
Spécifiez le chemin d'accès à un fichier JSON sur votre machine locale qui possède les données d'identification du fournisseur d'infrastructure pour l'emplacement Satellite. Le format des données d'identification est spécifique au fournisseur. Voir http://ibm.biz/sat-infra-creds.
--provider-region
Spécifiez la région du fournisseur d'infrastructure dans laquelle vous prévoyez de créer les hôtes pour l'emplacement Satellite. Si vous incluez cette option, vous devez également inclure l'option --provider.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--service-subnet
Spécifiez un routage CIDR de sous-réseau personnalisé pour fournir les adresses IP privées des services. Cette option n'est utilisée que si vous activez Red Hat CoreOS avec l'option --coreos-enabled. Le sous-réseau doit avoir une taille d'au /24 moins. Voir https://ibm.biz/sat-location-create. Valeur par défaut : 172.20.0.0/16

Exemples

Créer un emplacement Satellite

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

ibmcloud sat location dns get

Satellite

Affichez les détails d'un sous-domaine enregistré dans un emplacement Satellite.

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

Options de commande

--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--subdomain
Spécifiez le nom de sous-domaine. Pour afficher la liste des sous-domaines existants, exécutez ibmcloud sat location dns ls --location <ID>.

Exemples

Afficher les détails d'un sous-domaine enregistré dans un emplacement Satellite

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

ibmcloud sat location dns help

Afficher l'aide

ibmcloud sat location dns help

Exemples

Afficher l'aide

ibmcloud sat location dns help

ibmcloud sat location dns ls

Satellite

Répertoriez les sous-domaines enregistrés dans un emplacement Satellite.

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

Options de commande

--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier les sous-domaines enregistrés dans un emplacement Satellite

ibmcloud sat location dns ls --location LOCATION

ibmcloud sat location dns register

Satellite

Définissez un sous-domaine pour les hôtes affectés au plan de contrôle dans un emplacement Satellite.

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

Options de commande

--ip
Indiquez l'adresse IP de chaque hôte du plan de contrôle, au format --ip x.x.x.1 --ip x.x.x.2 --ip x.x.x.3. Pour les clusters multizones, utilisez une adresse IP pour chaque zone. Pour trouver l'adresse IP, exécutez ibmcloud sat host ls --location <location_ID_or_name> et recherchez Worker IP pour les hôtes portant la mention infrastructure.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Définir un sous-domaine pour les hôtes affectés au plan de contrôle dans un emplacement d’ Satellite

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

ibmcloud sat location get

Satellite

Affichez les détails d'un emplacement Satellite.

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

Options de commande

--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Afficher les détails d’un emplacement de l’ Satellite

ibmcloud sat location get --location LOCATION

ibmcloud sat location help

Afficher l'aide

ibmcloud sat location help

Exemples

Afficher l'aide

ibmcloud sat location help

ibmcloud sat location ls

Satellite

Répertoriez tous les emplacements Satellite de votre compte IBM Cloud.

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

Options de commande

--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertoriez tous les emplacements d’ Satellite s dans votre compte IBM Cloud

ibmcloud sat location ls

ibmcloud sat location rm

Satellite

Supprimez un emplacement. Avant d'exécuter cette commande, effectuez une sauvegarde de vos configurations et retirez les hôtes et les clusters qui s'exécutent dans l'emplacement. L'infrastructure hôte sous-jacente n'est pas supprimée automatiquement lorsque vous supprimez un emplacement. Cette action ne peut pas être annulée.

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

Options de commande

-f
Force la commande à s'exécuter sans invites utilisateur.
--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer un emplacement

ibmcloud sat location rm --location LOCATION

ibmcloud sat location update

Satellite

Mettre à jour le nom ou la description d'un emplacement d' Satellite.

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

Options de commande

--description
Saisissez une nouvelle description pour l'emplacement Satellite. La longueur de la description est limitée à 400 octets.
--location-id
L'identifiant de l'emplacement de l' Satellite. Pour trouver l'identifiant d'emplacement, exécutez ibmcloud sat location ls.
--name
Spécifiez un nouveau nom pour l'emplacement Satellite. Les noms de lieux doivent commencer par une lettre, peuvent contenir des lettres, des chiffres, des points (.) et des tirets (-), et doivent comporter moins de 36 caractères. Ne pas réutiliser les noms, y compris les noms des lieux supprimés.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Mettre à jour le nom ou la description d'un emplacement d' Satellite

ibmcloud sat location update --location-id ID

Commandes de messages

Afficher les messages utilisateur en cours.

ibmcloud sat messages

Virtual Private Cloud Classic infrastructure Satellite

Afficher les messages utilisateur en cours.

ibmcloud sat messages [-q]

Options de commande

-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Consultez les messages utilisateur actuels

ibmcloud sat messages

Commandes de ressource

Recherchez et affichez les ressources Kubernetes qui sont gérées par une configuration Satellite.

ibmcloud sat resource get

Satellite

Affichez les détails d'une ressource Kubernetes qui est gérée par une configuration Satellite.

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

Options de commande

--history
ID d'historique de la ressource.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--resource
Spécifiez l'ID de ressource Kubernetes. Pour trouver des ressources sur l' Kubernetes, exécutez ibmcloud sat resource ls.
--save-data
Téléchargez et sauvegardez une définition de ressource Kubernetes dans un fichier temporaire.

Exemples

Afficher les détails d'une ressource Kubernetes gérée par une configuration Satellite

ibmcloud sat resource get --resource RESOURCE

ibmcloud sat resource help

Afficher l'aide

ibmcloud sat resource help

Exemples

Afficher l'aide

ibmcloud sat resource help

ibmcloud sat resource history get

Satellite

Obtenez l'historique d'une ressource Kubernetes.

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

Options de commande

--limit
Spécifiez le nombre maximal d'entrées d'historique à renvoyer.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--resource
ID de ressource Kubernetes.

Exemples

Obtenir l'historique d'une ressource Kubernetes

ibmcloud sat resource history get --resource RESOURCE

ibmcloud sat resource history help

Afficher l'aide

ibmcloud sat resource history help

Exemples

Afficher l'aide

ibmcloud sat resource history help

ibmcloud sat resource ls

Satellite

Effectuez des recherches dans les ressources Kubernetes gérées par Satellite.

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

Options de commande

-c, --cluster
Spécifiez le nom ou l'ID du cluster enregistré dans lequel la ressource Kubernetes s'exécute. Pour rechercher les clusters enregistrés, exécutez ibmcloud sat cluster ls.
--limit
Spécifiez le nombre maximal d'entrées de ressource que la recherche doit renvoyer.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--search
Indiquez la chaîne permettant de filtrer les résultats de la recherche de ressources Kubernetes, telles qu'un nom de pod ou d'espace de nom.
--subscription
Spécifiez l'ID ou le nom de l'abonnement Satellite. Pour rechercher des abonnements, exécutez ibmcloud sat cluster ls.

Exemples

Rechercher des ressources d' Kubernetes s gérées par Satellite

ibmcloud sat resource ls --cluster CLUSTER

Commandes de service

Affichez les clusters de services Satellite.

ibmcloud sat service help

Afficher l'aide

ibmcloud sat service help

Exemples

Afficher l'aide

ibmcloud sat service help

ibmcloud sat service ls

Satellite

Répertoriez tous les clusters de service Satellite se trouvant dans votre emplacement afin de consulter leurs détails, tels que les ressources hôte demandées.

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

Options de commande

--location
Nom ou ID de l'emplacement Satellite. Pour trouver l'identifiant ou le nom de l'emplacement, exécutez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertoriez tous les clusters de services Satellite de votre site afin d'en consulter les détails, tels que les ressources hôtes demandées

ibmcloud sat service ls --location LOCATION

Commandes de stockage

Affichez et gérez des ressources de stockage Satellite.

ibmcloud sat storage assignment autopatch disable

La commande storage assignment autopatch disable est une fonction bêta.

Satellite

Désactiver les correctifs automatiques pour une affectation de stockage Satellite.

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

Options de commande

--all
Désactivez les correctifs automatiques pour toutes les affectations de stockage Satellite d'une configuration de stockage.
--assignment
ID de l'affectation de stockage Satellite. Pour répertorier les affectations de stockage disponibles pour la configuration, exécutez la commande ibmcloud sat storage assignment ls --config CONFIG.
--config
Nom ou ID d'une configuration de stockage Satellite. Pour répertorier les configurations de stockage disponibles, exécutez ibmcloud sat storage config ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Désactiver les correctifs automatiques pour une affectation de stockage Satellite

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

ibmcloud sat storage assignment autopatch enable

La commande storage assignment autopatch enable est une fonction bêta.

Satellite

Activer les correctifs automatiques pour une affectation de stockage Satellite.

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

Options de commande

--all
Activez les correctifs automatiques pour toutes les affectations de stockage Satellite d'une configuration de stockage.
--assignment
ID de l'affectation de stockage Satellite. Pour répertorier les affectations de stockage disponibles pour la configuration, exécutez la commande ibmcloud sat storage assignment ls --config CONFIG.
--config
Nom ou ID d'une configuration de stockage Satellite. Pour répertorier les configurations de stockage disponibles, exécutez ibmcloud sat storage config ls.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Activer les correctifs automatiques pour une affectation de stockage Satellite

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

ibmcloud sat storage assignment autopatch help

Afficher l'aide

ibmcloud sat storage assignment autopatch help

Exemples

Afficher l'aide

ibmcloud sat storage assignment autopatch help

ibmcloud sat storage assignment create

Satellite

Créez une affectation pour déployer vos configurations de stockage sur des clusters de votre emplacement Satellite.

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

Options de commande

-c, --cluster
Spécifiez l'ID du cluster Satellite pour l'affectation. Pour rechercher l'ID de cluster, exécutez ibmcloud oc cluster ls --provider satellite.
--config
Indiquez la configuration de stockage Satellite pour l'affectation. pour rechercher des configurations, exécutez ibmcloud sat storage config ls.
-g, --group
Spécifiez les groupes de clusters pour l'affectation. Pour rechercher des groupes de clusters, exécutez ibmcloud sat group ls.
--name
Indiquez un nom pour l'affectation de stockage Satellite.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--service-cluster-id
Spécifiez l'ID du cluster de service pour l'affectation. Pour trouver l'ID du cluster de services, exécutez ibmcloud sat service ls --location <location>.

Exemples

Créez une tâche pour déployer vos configurations de stockage sur les clusters de votre emplacement Satellite

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

ibmcloud sat storage assignment get

Satellite

Obtenir les détails d'une affectation de stockage Satellite.

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

Options de commande

--assignment
Spécifiez l'ID d'une affectation de stockage Satellite.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Découvrez les détails d'une affectation de stockage dans l' Satellite

ibmcloud sat storage assignment get --assignment ASSIGNMENT

ibmcloud sat storage assignment help

Afficher l'aide

ibmcloud sat storage assignment help

Exemples

Afficher l'aide

ibmcloud sat storage assignment help

ibmcloud sat storage assignment ls

Satellite

Affichez la liste des affectations de stockage Satellite dans votre compte IBM Cloud.

Pour répertorier toutes les affectations d'un cluster de services en tant qu'administrateur de service : ibmcloud sat storage assignation ls--service-cluster-id GRAPPE.

Pour répertorier toutes les affectations d'un cluster de services en tant qu'administrateur d'emplacement : ibmcloud sat storage assignation ls--location EMPLACEMENT--service-cluster-id GRAPPE.

Pour répertorier toutes les affectations d'une configuration : 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)

Options de commande

-c, --cluster
Spécifiez l'ID du cluster Satellite pour les affectations. Pour obtenir l'ID du cluster, exécutez ibmcloud oc cluster ls --provider satellite.
--config
Spécifiez le nom ou l'ID d'une configuration de stockage Satellite. Pour répertorier les configurations de stockage disponibles, exécutez ibmcloud sat storage config ls.
--location
Spécifiez le nom d'un emplacement Satellite. Pour afficher la liste des emplacements disponibles, exécutez ibmcloud sat location ls. Cette option ne peut pas être utilisée par l'administrateur de service.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--service-cluster-id
Spécifiez l'ID du cluster de service pour les affectations. Pour trouver l'ID du cluster de services, exécutez ibmcloud sat service ls --location <location>.

Exemples

Répertoriez les attributions de stockage d' Satellite s dans votre compte IBM Cloud

ibmcloud sat storage assignment ls --cluster CLUSTER

ibmcloud sat storage assignment patch

Satellite

Appliquez les modifications de configuration de stockage aux affectations associées.

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

Alias : ibmcloud sat upgrade

Options de commande

--assignment
Spécifiez l'ID d'une affectation de stockage Satellite. Pour afficher la liste des missions disponibles, exécutez ibmcloud sat storage assignment ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Appliquer les modifications de configuration du stockage aux affectations associées

ibmcloud sat storage assignment patch --assignment ASSIGNMENT

ibmcloud sat storage assignment rm

Satellite

Supprimez une assignation de stockage Satellite. Les ressources Kubernetes sont supprimées de tous les clusters dans votre emplacement Satellite, mais la configuration est conservée.

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

Options de commande

--assignment
Spécifiez l'ID d'une affectation de stockage Satellite. Pour trouver des missions, exécutez ibmcloud sat storage assignment ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer une affectation de stockage sur Satellite

ibmcloud sat storage assignment rm --assignment ASSIGNMENT

ibmcloud sat storage assignment update

Satellite

Mettez à jour une affectation de stockage Satellite.

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

Options de commande

--assignment
Spécifiez l'ID d'une affectation de stockage Satellite.
-f
Force la commande à s'exécuter sans invites utilisateur.
-g, --group
Spécifiez les nouveaux groupes de clusters pour l'affectation. Pour afficher la liste des groupes disponibles, exécutez ibmcloud sat group ls.
--name
Indiquez un nouveau nom pour l'affectation de stockage Satellite.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Mettre à jour une affectation de stockage d' Satellite

ibmcloud sat storage assignment update --assignment ASSIGNMENT

ibmcloud sat storage config class add

Satellite

Créez une classe de stockage Satellite personnalisée.

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

Options de commande

--config-name
Spécifiez le nom de la configuration de stockage pour la classe de stockage personnalisée. Pour répertorier les configurations de stockage d' Satellite, exécutez ibmcloud sat storage config ls.
--name
Indiquez un nom pour la classe de stockage personnalisée.
-p, --param
Spécifiez une paire key=value de paramètres de classe de stockage. Pour afficher les paramètres de classe de stockage dans un modèle de stockage, exécutez ibmcloud sat storage template get.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Créer une classe de stockage personnalisée pour Satellite

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

ibmcloud sat storage config class get

Satellite

Obtenir les détails d'une classe de stockage Satellite.

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

Options de commande

--class
Spécifiez le nom d'une classe de stockage Satellite.
--config
Spécifiez le nom ou l'ID d'une configuration de stockage Satellite. Pour répertorier les configurations de stockage d' Satellite, exécutez ibmcloud sat storage config ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Découvrez les détails d'une classe de stockage Satellite

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

ibmcloud sat storage config class help

Afficher l'aide

ibmcloud sat storage config class help

Exemples

Afficher l'aide

ibmcloud sat storage config class help

ibmcloud sat storage config class ls

Satellite

Répertorier les classes de stockage dans une configuration de stockage Satellite

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

Options de commande

--config
Spécifiez le nom ou l'ID d'une configuration de stockage Satellite. Pour répertorier les configurations de stockage d' Satellite, exécutez ibmcloud sat storage config ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--show-params
Incluez cette option pour répertorier tous les détails des paramètres de classe de stockage.

Exemples

Répertorier les classes de stockage dans une configuration de stockage Satellite

ibmcloud sat storage config class ls --config CONFIG

ibmcloud sat storage config create

Satellite

Créez une configuration de stockage Satellite pour installer des pilotes de stockage dans vos clusters.

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

Options de commande

--location
Entrez l'ID ou le nom de l'emplacement de la configuration de stockage. Pour connaître les lieux disponibles, lancez ibmcloud sat location ls.
--name
Spécifiez le nom de la configuration de stockage.
-p, --param
Spécifiez une paire key=value pour les paramètres de configuration. Pour afficher les paramètres de configuration d'un modèle de stockage, exécutez ibmcloud sat storage template get.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--template-name
Indiquez le nom de modèle de configuration de stockage Satellite. Pour afficher la liste des modèles de configuration de stockage disponibles, exécutez ibmcloud sat storage template ls.
--template-version
Indiquez la version des modèles de configuration de stockage Satellite. Si vous n'incluez pas cette option, la version par défaut est utilisée. Pour afficher la liste des modèles de configuration de stockage disponibles, exécutez ibmcloud sat storage template ls.

Exemples

Créez une configuration de stockage Satellite pour installer les pilotes de stockage dans vos clusters

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

ibmcloud sat storage config get

Satellite

Obtenir les détails d'une configuration de stockage Satellite.

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

Options de commande

--config
Spécifiez le nom ou l'ID d'une configuration de stockage Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat storage config ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Découvrez les détails d'une configuration de stockage Satellite

ibmcloud sat storage config get --config CONFIG

ibmcloud sat storage config help

Afficher l'aide

ibmcloud sat storage config help

Exemples

Afficher l'aide

ibmcloud sat storage config help

ibmcloud sat storage config ls

Satellite

Affichez la liste des configurations de stockage Satellite dans votre compte IBM Cloud.

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

Options de commande

--location
Spécifiez l'ID ou le nom de l'emplacement contenant les configurations à répertorier. Pour connaître les lieux disponibles, lancez ibmcloud sat location ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertoriez les configurations de stockage d' Satellite s dans votre compte IBM Cloud

ibmcloud sat storage config ls

ibmcloud sat storage config param help

Afficher l'aide

ibmcloud sat storage config param help

Exemples

Afficher l'aide

ibmcloud sat storage config param help

ibmcloud sat storage config param set

Satellite

Définissez les paramètres de configuration et de secret d'une configuration de stockage Satellite.

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

Options de commande

--apply
Appliquez la dernière version de la configuration de stockage Satellite à toutes les affectations d'une configuration. Pour afficher les affectations d'une configuration, exécutez ibmcloud sat storage assignment ls --config CONFIG.
--config
Spécifiez le nom ou l'ID de la configuration de stockage. Pour répertorier les configurations de stockage d' Satellite, exécutez ibmcloud sat storage config ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
-p, --param
Spécifiez une paire key=value pour les paramètres de configuration. Pour afficher les paramètres de configuration d'un modèle de stockage, exécutez ibmcloud sat storage template get.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Définir les paramètres de configuration et les secrets d'une configuration de stockage Satellite

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

ibmcloud sat storage config patch

Satellite

Appliquez les derniers correctifs à une configuration de stockage Satellite. Les mises à jour de correctif contiennent des correctifs de vulnérabilité et des correctifs de bogue dans la même version majeure.

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

Alias : ibmcloud sat upgrade

Options de commande

--config
Spécifiez le nom ou l'ID d'une configuration de stockage Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat storage config ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
--include-assignments
Cochez cette option pour mettre à jour les attributions de la configuration de stockage vers la dernière version de configuration.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Appliquer les derniers correctifs à une configuration de stockage Satellite

ibmcloud sat storage config patch --config CONFIG

ibmcloud sat storage config rm

Satellite

Retirer une configuration de stockage Satellite.

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

Options de commande

--config
Spécifiez le nom ou l'ID d'une configuration de stockage Satellite. Pour afficher la liste des configurations disponibles, exécutez la commande ibmcloud sat storage config ls.
-f
Force la commande à s'exécuter sans invites utilisateur.
--include-assignments
Incluez cette option pour supprimer la configuration de stockage ainsi que les affectations associées.
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Supprimer une configuration de stockage Satellite

ibmcloud sat storage config rm --config CONFIG

ibmcloud sat storage help

Afficher l'aide

ibmcloud sat storage help

Exemples

Afficher l'aide

ibmcloud sat storage help

ibmcloud sat storage template get

Satellite

Obtenir les détails d'un modèle de stockage Satellite

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

Options de commande

--name
Indiquez le nom de modèle de stockage. Pour afficher la liste des modèles de stockage disponibles, exécutez ibmcloud sat storage template ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--version
Indiquez la version de modèle de stockage. Pour afficher la liste des modèles de stockage disponibles, exécutez ibmcloud sat storage template ls.

Exemples

Obtenir les détails d'un modèle de stockage Satellite

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

ibmcloud sat storage template help

Afficher l'aide

ibmcloud sat storage template help

Exemples

Afficher l'aide

ibmcloud sat storage template help

ibmcloud sat storage template ls

Satellite

Affichez la liste des modèles de stockage Satellite disponibles.

ibmcloud sat storage template ls [-q]

Options de commande

-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier les modèles de stockage disponibles pour l' Satellite

ibmcloud sat storage template ls

Commandes d'abonnement

Affichez et gérez les abonnements Satellite pour déployer les fichiers de configuration Kubernetes dans vos clusters.

ibmcloud sat subscription create

Satellite

Créez un abonnement Satellite pour les clusters. Une fois l'abonnement créé, la version de configuration Satellite associée est déployée automatiquement dans les clusters abonnés.

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)

Options de commande

--auth-required
Indiquez le secret d'authentification requis pour la connexion au référentiel distant. Pour plus d'informations, voir https://ibm.biz/sat-config-private-repo. Stratégie : GitOps.
--config
Spécifiez le nom de la configuration à utiliser pour l'abonnement. Pour connaître les configurations disponibles, exécutez ibmcloud sat config ls.
-g, --group
Spécifiez le nom ou l'ID des groupes de clusters à abonner à votre configuration. Pour rechercher les groupes de clusters disponibles, exécutez ibmcloud sat group ls.
--gitref
Spécifiez le GitRef à utiliser pour l'abonnement Satellite. Stratégie : GitOps.
--gitref-type
Indiquez le type de GitRef à utiliser pour l'abonnement Satellite. Stratégie : GitOps. Valeurs autorisées: branch, commit, tag, release
--name
Entrez un nom pour l'abonnement.
--path
Indiquez le chemin d'accès aux fichiers de référentiel ou aux actifs d'édition dans le référentiel distant à utiliser pour l'abonnement Satellite. Stratégie : GitOps.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--repository
Spécifiez l'URL du référentiel distant à utiliser pour l'abonnement. Stratégie : GitOps.
--version
Indiquez le nom ou l'ID de la version de configuration existante à utiliser pour l'abonnement. Pour trouver les versions, exécutez ibmcloud sat config get --config <configuration_name_or_ID>. Stratégie : Transfert direct.

Exemples

Créer un abonnement à l' Satellite pour les 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

Obtenez des informations détaillées sur un abonnement Satellite.

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

Options de commande

--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--subscription
Saisissez le nom ou l'identifiant d'un abonnement à l' Satellite. Pour rechercher des abonnements, exécutez ibmcloud sat subscription ls.

Exemples

Obtenez des informations détaillées sur l'abonnement à Satellite

ibmcloud sat subscription get --subscription SUBSCRIPTION

ibmcloud sat subscription help

Afficher l'aide

ibmcloud sat subscription help

Exemples

Afficher l'aide

ibmcloud sat subscription help

ibmcloud sat subscription identity help

Afficher l'aide

ibmcloud sat subscription identity help

Exemples

Afficher l'aide

ibmcloud sat subscription identity help

ibmcloud sat subscription identity set

Satellite

Mettez à jour l'abonnement Satellite afin d'utiliser votre identité pour gérer les ressources.

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

Options de commande

-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--subscription
Spécifiez le nom ou l'ID d'un abonnement Satellite. Pour afficher la liste des abonnements, exécutez ibmcloud sat subscription ls.

Exemples

Mettez à jour votre abonnement à l' Satellite e afin d'utiliser votre identité pour gérer les ressources

ibmcloud sat subscription identity set --subscription SUBSCRIPTION

ibmcloud sat subscription ls

Satellite

Répertoriez tous les abonnements Satellite dans votre compte IBM Cloud.

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

Options de commande

-c, --cluster
Spécifiez le nom ou l'ID du cluster Satellite. Pour rechercher les clusters enregistrés, exécutez ibmcloud sat cluster ls.
--output
Imprime la sortie de commande dans le format fourni. Valeurs acceptées : json
-q
Permet de masquer le message du jour et les rappels de mise à jour.

Exemples

Répertorier tous les abonnements à Satellite dans votre compte IBM Cloud

ibmcloud sat subscription ls

ibmcloud sat subscription rm

Satellite

Retirez un abonnement Satellite. Les ressources Kubernetes ne sont plus déployées dans vos clusters.

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

Options de commande

-f
Force la commande à s'exécuter sans invites utilisateur.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--subscription
Indiquez le nom ou l'ID d'un abonnement Satellite. Pour afficher la liste des abonnements, exécutez ibmcloud sat subscription ls.

Exemples

Résilier un abonnement à Satellite

ibmcloud sat subscription rm --subscription SUBSCRIPTION

ibmcloud sat subscription update

Satellite

Mettez à jour un abonnement 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)

Options de commande

--auth-required
Indiquez le secret d'authentification requis pour la connexion au référentiel distant. Stratégie : GitOps.
-f
Force la commande à s'exécuter sans invites utilisateur.
-g, --group
Spécifiez les nouveaux groupes de clusters à abonner à votre configuration.
--gitref
Spécifiez le GitRef à utiliser pour l'abonnement Satellite. Stratégie : GitOps.
--gitref-type
Indiquez le type de GitRef à utiliser pour cet abonnement Satellite. Stratégie : GitOps. Valeurs autorisées: branch, commit, tag, release
--name
Indiquez un nouveau nom pour l'abonnement Satellite.
--path
Indiquez le chemin d'accès aux fichiers de référentiel ou aux actifs d'édition dans le référentiel distant à utiliser pour l'abonnement Satellite. Stratégie : GitOps.
-q
Permet de masquer le message du jour et les rappels de mise à jour.
--repository
Indiquez l'URL du référentiel distant à utiliser pour l'abonnement Satellite. Stratégie : GitOps.
--subscription
Spécifiez le nom ou l'ID d'un abonnement Satellite. Pour afficher la liste des abonnements, exécutez ibmcloud sat subscription ls.
--version
Indiquez la version de configuration existante à utiliser pour l'abonnement Satellite. Stratégie : Transfert direct.

Exemples

Mettre à jour un abonnement à l' Satellite

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