Création de votre image AppStream 2.0 par programmation à l'aide des opérations d'interface de ligne de commande (CLI) Image Assistant

Vous pouvez créer des images Amazon AppStream 2.0 en vous connectant à une instance Image Builder et en utilisant l'interface utilisateur graphique d'Image Assistant ou les opérations de l'interface de ligne de commande (CLI). Les opérations d'interface de ligne de commande Image Assistant fournissent des fonctionnalités similaires à l’interface utilisateur graphique d’Image Assistant. Avec ces opérations, vous pouvez effectuer les actions suivantes par programmation :

• Gérer les applications incluses dans une image.

• Enregistrer, mettre à jour et réinitialiser les paramètres par défaut d’une application.

• Activer ou désactiver le cadre d'application dynamique AppStream 2.0.

• Spécifier des balises.

• Créer une image.

Vous pouvez utiliser ces opérations pour intégrer la création d'image AppStream 2.0 à votre processus de développement logiciel d'intégration ou de déploiement en continu.

Pour utiliser les opérations d’interface de ligne de commande d’Image Assistant, utilisez le shell de ligne de commande de votre choix sur un Image Builder. Par exemple, vous pouvez utiliser l'invite de commande Windows ou PowerShell.

Note

L'instance Image Builder doit utiliser une version de l'agent AppStream 2.0 publiée à partir du 26 juillet 2019. Si vous ne disposez pas d'une instance Image Builder, vous devez en créer une. Pour plus d'informations, consultez Lancer un Image Builder pour l'installation et la configuration d'applications de streaming.

Création des paramètres d’application et Windows par défaut avec les opérations d'interface de ligne de commande d’Image Assisant

Vous pouvez créer des paramètres d'application et Windows par défaut afin que vos utilisateurs puissent démarrer rapidement avec leurs applications. Lorsque vous créez ces paramètres, AppStream 2.0 remplace le profil d'utilisateur Windows par défaut par le profil que vous configurez. Le profil utilisateur Windows par défaut est ensuite utilisé pour créer les paramètres initiaux pour les utilisateurs dans l'instance de flotte. Si vous créez ces paramètres à l'aide des opérations d’interface de ligne de commande Image Assistant, votre programme d'installation de l'application, ou l'automatisation, doit modifier le profil d’utilisateur Windows par défaut directement.

Pour remplacer le profil d’utilisateur Windows par défaut par celui d’un autre utilisateur Windows, vous pouvez également utiliser l'opération d’interface de ligne de commande update-default-profile d’Image Assistant.

Pour plus d'informations sur la configuration des paramètres d'application et Windows par défaut, consultez Création de paramètres par défaut pour les applications et Windows pour vos utilisateurs AppStream 2.0 dans Paramètres par défaut pour les applications et Windows et performances de lancement des applications.

Optimisation des performances de lancement de vos applications avec les opérations d’interface de ligne de commande d’Image Assistant

AppStream 2.0 vous permet d'optimiser les performances de lancement de vos applications pour les sessions de streaming de vos utilisateurs. Lorsque vous utilisez pour ce faire des opérations d’interface de ligne de commande d’Image Assistant, vous pouvez spécifier les fichiers à optimiser pour le lancement de votre application. L’ajout de fichiers au manifeste d’optimisation d’application réduit le temps nécessaire au lancement initial d’une application sur une nouvelle instance de flotte. Toutefois, cela augmente également le temps nécessaire pour que les instances de flotte soient mises à la disposition des utilisateurs. Le manifeste d'optimisation est un fichier texte délimité par des lignes spécifique à l’application.

Note

Si vous intégrez des manifestes d’optimisation d'application en utilisant à la fois des opérations d’interface de ligne de commande d’Image Assistant et l’interface utilisateur graphique d’Image Assistant, les manifestes sont fusionnés.

Voici un exemple de fichier manifeste d'optimisation des applications :

C:\Program Files (x86)\Notepad++\autoCompletion
C:\Program Files (x86)\Notepad++\localization
C:\Program Files (x86)\Notepad++\plugins
C:\Program Files (x86)\Notepad++\themes
C:\Program Files (x86)\Notepad++\updater
C:\Program Files (x86)\Notepad++\userDefineLangs
C:\Program Files (x86)\Notepad++\change.log
C:\Program Files (x86)\Notepad++\config.xml
C:\Program Files (x86)\Notepad++\contextMenu.xml
C:\Program Files (x86)\Notepad++\doLocalConf.xml
C:\Program Files (x86)\Notepad++\functionList.xml
C:\Program Files (x86)\Notepad++\langs.model.xml
C:\Program Files (x86)\Notepad++\license.txt
C:\Program Files (x86)\Notepad++\notepad++.exe
C:\Program Files (x86)\Notepad++\readme.txt
C:\Program Files (x86)\Notepad++\SciLexer.dll
C:\Program Files (x86)\Notepad++\shortcuts.xml
C:\Program Files (x86)\Notepad++\stylers.model.xml

Pour plus d'informations sur l'optimisation des performances de lancement de vos applications, consultez Optimisation des performances de lancement de vos applications dans Paramètres par défaut pour les applications et Windows et performances de lancement des applications.

Présentation du processus de création par programmation d'une image AppStream 2.0

Vous pouvez utiliser les opérations d'interface de ligne de commande d'Image Assistant avec votre automatisation de l'installation d'une application pour créer un flux de travail de création d'image AppStream 2.0 par programmation. Une fois votre demande d'automatisation d'installation terminée, mais avant la création de l'image, utilisez les opérations d'interface de ligne de commande d’Image Assistant pour spécifier les éléments suivants :

• Les fichiers exécutables que vos utilisateurs peuvent lancer

• Les manifestes d’optimisation pour vos applications

• Autres métadonnées d'image AppStream 2.0

La présentation générale suivante décrit le processus de création par programmation d'une image AppStream 2.0.

1. Utilisez l’automatisation d’installation de votre application pour installer les applications requises sur votre mage Builder. Cette installation peut inclure des applications que vos utilisateurs lanceront, des dépendances, et des applications en arrière-plan.

2. Déterminez les fichiers et les dossiers à optimiser.

3. Le cas échéant, utilisez l'opération d'interface de ligne de commande add-application d'Image Assistant pour spécifier les métadonnées d'application et le manifeste d'optimisation pour l'image AppStream 2.0.

4. Pour spécifier des applications supplémentaires pour l'image AppStream 2.0, répétez les étapes 1 à 3 pour chaque application en fonction des besoins.

5. Le cas échéant, utilisez l'opération d’interface de ligne de commande update-default-profile d’Image Assistant pour remplacer le profil Windows par défaut et créer les paramètres d’application et Windows par défaut pour vos utilisateurs.

6. Utilisez l'opération d’interface de ligne de commande create-image d’Image Assistant pour créer l'image.

Opérations d'interface de ligne de commande d'Image Assistant pour la création et la gestion de votre image AppStream 2.0

Cette section décrit les opérations d'interface de ligne de commande d'Image Assistant que vous pouvez utiliser pour créer et gérer votre image AppStream 2.0.

Sur les instances Image Builder Windows, le chemin du fichier exécutable incluant l'interface de ligne de commande est : C:\Program Files\Amazon\Photon\ConsoleImageBuilder\Image-Assistant.exe. Pour plus de commodité, ce fichier exécutable est inclus dans la variable Windows PATH. Cela vous permet d'appeler les opérations d'interface de ligne de commande d’Image Assistant sans spécifier le chemin absolu vers le fichier exécutable. Pour appeler ces opérations, tapez la commande image-assistant.exe.

Sur les instances Image Builder Linux, l'outil Image Assistant se trouve dans /usr/local/appstream/image-assistant/AppStreamImageAssistant, avec un lien symbolique dans /bin/AppStreamImageAssistant.

Opération help

Extrait une liste de toutes les opérations d'interface de ligne de commande d’Image Assistant. Pour chaque opération de la liste, la description et la syntaxe d'utilisation sont fournies. Pour afficher l'aide relative à une opération spécifique, tapez le nom de l'opération et spécifiez le paramètre -help. Par exemple :

add-application --help

Résumé

help

Sortie

Imprime sur la sortie standard la liste des opérations disponibles avec une description de leur fonction.

Opération add-application

Ajoute l'application à la liste des applications pour les utilisateurs AppStream 2.0. Les applications de cette liste sont incluses dans le catalogue d'applications. Le catalogue des applications est visible par les utilisateurs lorsque ces derniers se connectent à une session de streaming AppStream 2.0.

Note

Si vous devez apporter des modifications à la configuration d'une application, supprimez-la et ajoutez-la avec les paramètres mis à jour.

Résumé

add-application
--name <value>
--absolute-app-path <value>
[--display-name <value>]
[--absolute-icon-path <value>]
[--working-directory <value>]
[--launch-parameters <""-escaped value>]
[--absolute-manifest-path <value>]

Options

--name (chaîne)

Nom unique de l'application. La longueur maximale est de 256 caractères. Vous pouvez ajouter jusqu'à 50 applications. Vous ne pouvez pas utiliser d’espace.

--absolute-app-path (chaîne)

Chemin absolu vers le fichier exécutable, le fichier de commandes ou le script pour l'application. Le chemin doit pointer vers un fichier valide.

--display-name (chaîne)

Nom à afficher pour l'application dans le catalogue d'applications. Si vous ne spécifiez pas de nom d'affichage, AppStream 2.0 crée un nom dérivé du nom du fichier exécutable. Le nom est créé sans l'extension de fichier et avec des traits de soulignement à la place des espaces. La longueur maximale est de 256 caractères.

--absolute-icon-path (chaîne)

Chemin absolu vers l'icône de l'application. Le chemin doit pointer vers un fichier d'icône valide de type .jpg, .png ou .bmp. Les dimensions maximales sont : 256 px x 256 px. Si vous ne spécifiez pas de chemin d'accès, l'icône par défaut pour le fichier exécutable est utilisée, si elle est disponible. Si aucune icône par défaut n'est disponible pour le fichier exécutable, une icône d'application AppStream 2.0 par défaut est utilisée.

--working-directory (chaîne)

Répertoire de travail initial pour l'application lorsque celle-ci est lancée.

--absolute-manifest-path (chaîne)

Chemin d'accès à un nouveau fichier texte séparé par des lignes. Le fichier spécifie le chemin absolu des fichiers à optimiser avant que l'instance de flotte soit disponible à un utilisateur pour le streaming. Le chemin doit pointer vers un fichier texte valide.

Sortie de message

Code de sortie	Message imprimé sur la sortie standard	Description
0	{"status": 0, "message": "Success"}	L'application a été ajoutée avec succès.
1	{"status": 1, "message": "Administrator privileges are required to perform this operation"}	Les privilèges d'administrateur sont nécessaires pour effectuer l'opération.
1	{"status": 1, "message": "Unable to add more than 50 apps to the catalog."}	L'application n'a pas pu être ajoutée, car le nombre maximal d'applications pouvant être ajoutées au catalogue d'applications AppStream 2.0 est 50.
1	{"status": 1, "message": "Name is not unique"}	Une application portant ce nom existe déjà dans le catalogue d'applications AppStream 2.0.
1	{"status": 1, "message": "File not found (chemin_application_absolu)"}	Le fichier spécifié pour absolute-app-path est introuvable.
1	{"status": 1, "message": "Unsupported file extension"}	Le paramètre Absolute-app-path prend uniquement en charge les types de fichiers suivants : .exe et .bat.
1	{"status": 1, "message": "Directory not found (répertoire_travail)"	Le répertoire spécifié pour working-directory est introuvable.
1	{"status": 1, "message": "Optimization-manifest not found: <nom_fichier>"}	Le fichier spécifié pour optimization-manifest est introuvable.
1	{"status": 1, "message": "File not found: <nom_fichier>"}	Un fichier spécifié dans le manifeste d'optimisation est introuvable.
255	{"status": 255, "message": <message_erreur>}	Une erreur inattendue s'est produite. Répétez la demande. Si l'erreur persiste, contactez AWS Support pour obtenir de l'aide. Pour plus d'informations, consultez le Centre AWS Support.

Opération remove-application

Supprime une application de la liste d'applications pour l'image AppStream 2.0. L'application n'est pas désinstallée ou modifiée, mais les utilisateurs ne seront pas en mesure de la lancer à partir du catalogue d'applications AppStream 2.0.

Résumé

remove-application
--name <value>

Options

--name (chaîne)

Identifiant unique de l'application à supprimer.

Sortie de message

Code de sortie	Message imprimé sur la sortie standard	Description
0	{"status": 0, "message": "Success"}	L'application a été supprimée avec succès.
1	{"status": 1, "message": "Administrator privileges are required to perform this operation"}	Les privilèges d'administrateur sont nécessaires pour effectuer l'opération.
1	{"status": 1, "message": "App not found"}	L'application spécifiée est introuvable dans le catalogue d'applications AppStream 2.0.
255	{"status": 255, "message": <message_erreur>}	Une erreur inattendue s'est produite. Répétez la demande. Si l'erreur persiste, contactez AWS Support pour obtenir de l'aide. Pour plus d'informations, consultez le Centre AWS Support.

Opération list-applications

Répertorie toutes les applications spécifiées dans le catalogue d'applications.

Résumé

list-applications

Sortie de message

Code de sortie	Message imprimé sur la sortie standard	Description
0	{"status": 0, "message": "Success", "applications": [ {..app1.. }, { ..app2.. }]}	Liste des applications dans le catalogue d'applications AppStream 2.0.
255	{"status": 255, "message": <message_erreur>}	Une erreur inattendue s'est produite. Répétez la demande. Si l'erreur persiste, contactez AWS Support pour obtenir de l'aide. Pour plus d'informations, consultez le Centre AWS Support.

Opération update-default-profile

Copie le profil de l’utilisateur Windows spécifié dans le profil d’utilisateur Windows par défaut. Les nouveaux utilisateurs qui diffusent héritent des paramètres stockés dans le profil spécifié.

Note

Cette opération n'est pas prise en charge par l'outil CLI Image Assistant Linux.

Résumé

update-default-profile
[--profile <value>]

Options

--profile (chaîne)

Nom de l'utilisateur dont le profil Windows Windows sera copié dans le profil utilisateur Windows par défaut. Utilisez le format suivant pour le nom :

"<domaine>\<nom_utilisateur>"

Si votre instance Image Builder n'est pas jointe à un domaine Microsoft Active Directory, entrez un point « . » pour le domaine. Si vous ne spécifiez pas d'utilisateur, le compte AppStream 2.0 Template User est utilisé.

Sortie de message

Code de sortie	Message imprimé sur la sortie standard	Description
0	{"status": 0, "message": "Success"}	Les paramètres utilisateur ont été copiés dans le profil Windows par défaut.
1	{"status": 1, "message": "Administrator privileges are required to perform this operation"}	Les privilèges d'administrateur sont nécessaires pour effectuer l'opération.
1	{"status": 1, "message": "Unable to copy file or folder: <chemin>. <raison>"}	Les paramètres utilisateur n'ont pas pu être copiés, car un fichier ou un dossier était indisponible.
1	{"status": 1, "message": "Cannot copy a domain user when not joined to a domain""}	Un utilisateur du domaine Microsoft Active Directory a été spécifié, mais l'instance Image Builder n'est jointe à aucun domaine Active Directory.
255	{"status": 255, "message": <message_erreur>}	Une erreur inattendue s'est produite. Répétez la demande. Si l'erreur persiste, contactez AWS Support pour obtenir de l'aide. Pour plus d'informations, consultez le Centre AWS Support.

Opération reset-user-profile

Supprime le profil utilisateur Windows pour l'utilisateur spécifié.

Note

Cette opération n'est pas prise en charge par l'outil CLI Image Assistant Linux.

Résumé

reset-user-profile
[--profile <value>]

Options

--profile (chaîne)

Nom de l'utilisateur Windows dont le profil Windows sera supprimé. Utilisez le format suivant pour le nom :

"<domaine>\<nom_utilisateur>"

Si votre instance Image Builder n'est pas jointe à un domaine Microsoft Active Directory, entrez un point « . » pour le domaine.

Sortie de message

Code de sortie	Message imprimé sur la sortie standard	Description
0	{"status": 0, "message": "Success"}	Les paramètres de l'utilisateur spécifié ont été supprimés avec succès.
1	{"status": 1, "message": "Administrator privileges are required to perform this operation"}	Les privilèges d'administrateur sont nécessaires pour effectuer l'opération.
1	{"status": 1, "message": "Unable to copy file or folder: <chemin>. <raison>"}	Les paramètres de l'utilisateur n'a pas pu être réinitialisés, car un fichier ou un dossier était indisponible.
1	{"status": 1, "message": "Cannot copy a domain user when not joined to a domain""}	Un utilisateur du domaine Microsoft Active Directory a été spécifié, mais l'instance Image Builder n'est jointe à aucun domaine Active Directory.
255	{"status": 255, "message": <message_erreur>}	Une erreur inattendue s'est produite. Répétez la demande. Si l'erreur persiste, contactez AWS Support pour obtenir de l'aide. Pour plus d'informations, consultez le Centre AWS Support.

Opération create-image

Démarre le flux de travail de création d'image, ce qui crée une image AppStream 2.0 pouvant être utilisée pour les flottes AppStream 2.0.

Résumé

create-image
--name <value>
[--description <value>]
[--display-name <value>]
[--enable-dynamic-app-catalog] | [--no-enable-dynamic-app-catalog]
[--use-latest-agent-version] | [--no-use-latest-agent-version]            
[--tags <value>]
[--dry-run]

Options

--name (chaîne)

Nom de l'image AppStream 2.0. Ce nom doit être unique dans le compte Amazon Web Services et la région AWS. La longueur maximale est de 100 caractères. Les caractères autorisés sont les suivants :

a-z, A-Z, 0-9, traits de soulignement (_), tirets (-) et points (.)

Le nom d'image ne peut pas commencer par un des préfixes suivants : « aws », « appstream » et « amazon ». Ces préfixes sont réservés pour une utilisation AWS.

--description (chaîne)

Description à afficher pour l'image. La longueur maximale est de 256 caractères.

--display-name (chaîne)

Nom à afficher pour l'image. La longueur maximale est de 256 caractères.

--enable-dynamic-app-catalog | --no-enable-dynamic-app-catalog

Active ou désactive la prise en charge du cadre d'application dynamique AppStream 2.0. Si vous ne spécifiez aucun paramètre, la prise en charge du cadre d’application dynamique n'est pas activée.

Le cadre d'application dynamique fournit des opérations au sein d'une instance de streaming AppStream 2.0 que vous pouvez utiliser pour générer un fournisseur d'application dynamique. Les fournisseurs d'application dynamique peuvent utiliser ces opérations pour modifier le catalogue d'applications auquel vos utilisateurs peuvent accéder en temps réel. Pour plus d'informations, consultez Utilisation du cadre d'application dynamique AppStream 2.0 pour créer un fournisseur d'applications dynamiques.

--use-latest-agent-version | --no-use-latest-agent-version

Indique s'il faut épingler l'image à la version de l'agent AppStream 2.0 actuellement installé ou toujours utiliser la dernière version de l'agent. Si vous ne spécifiez aucun paramètre, l'image est épinglée à la version de l'agent AppStream 2.0 actuellement installée. Pour plus d'informations, consultez Gérer les versions de l'agent AppStream 2.0.

--tags (chaîne)

Balises à associer à l'image. Une balise est une paire clé-valeur. Utilisez le format suivant :

--tags "mykey" "myval" "mykey2" "myval2"

Pour en savoir plus sur les identifications, consultez Balisage des ressources Amazon AppStream 2.0.

--dry-run (chaîne)

Effectue une validation sans créer l'image. Utilisez cette commande pour vérifier si votre image contient des problèmes avant de la créer.

Sortie de message

Code de sortie	Message imprimé sur la sortie standard	Description
0	{"status": 0, "message": "Success"}	Le flux de travail utilisé pour créer l'image a été lancé avec succès.
1	{"status": 1, "message": "Administrator privileges are required to perform this operation"}	Les privilèges d'administrateur sont nécessaires pour effectuer l'opération.
1	{"status": 1, "message": "An image with the given name already exists"}	Une image du même nom existe déjà dans le compte Amazon Web Services.
1	{"status": 1, "message": "Invalid value (balises)"}	Les balises spécifiées ne sont pas valides.
255	{"status": 255, "message": <message_erreur>}	Une erreur inattendue s'est produite. Répétez la demande. Si l'erreur persiste, contactez AWS Support pour obtenir de l'aide. Pour plus d'informations, consultez le Centre AWS Support.