Operaciones de la CLI de Image Assistant para crear y administrar imágenes de Amazon AppStream 2.0
En esta sección, se describen las operaciones de la CLI de Image Assistant que puede utilizar para crear y administrar una imagen de AppStream 2.0.
En generadores de imágenes de Windows, el archivo ejecutable que incluye la interfaz de la línea de comandos se encuentra en: C:\Program Files\Amazon\Photon\ConsoleImageBuilder\Image-Assistant.exe. Para su comodidad, este archivo ejecutable se incluye en la variable PATH de Windows. Esto le permite llamar a las operaciones de la CLI de Image Assistant sin especificar la ruta completa del archivo ejecutable. Para llamar a estas operaciones, escriba el comando image-assistant.exe.
En los generadores de imágenes de Linux, la herramienta de Image Assistant se encuentra en /usr/local/appstream/image-assistant/AppStreamImageAssistant, con un enlace simbólico en /bin/AppStreamImageAssistant.
helpOperación de
Recupera una lista de todas las operaciones de la CLI de Image Assistant. Para cada operación de la lista, se muestra una descripción y la sintaxis de uso. Para mostrar ayuda para una operación específica, escriba el nombre de la operación y especifique el parámetro -help. Por ejemplo:
add-application --help
Sinopsis
help
Output
Imprime en la salida estándar la lista de las operaciones disponibles con una descripción de su función.
add-applicationOperación de
Añade la aplicación a la lista de aplicaciones para los usuarios de AppStream 2.0. Las aplicaciones de esta lista se incluyen en el catálogo de aplicaciones. El catálogo de aplicaciones se muestra a los usuarios cuando inician una sesión de streaming de AppStream 2.0.
nota
Si necesita realizar cambios en la configuración de una aplicación, elimine la aplicación y añada la aplicación con la configuración actualizada.
Sinopsis
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>]
Opciones
--name(cadena)-
Un nombre único para la aplicación. La longitud máxima es de 256 caracteres. Puede añadir hasta 50 aplicaciones. No puede utilizar caracteres de espacio en blanco.
--absolute-app-path(cadena)-
La ruta completa del archivo ejecutable, el archivo de procesamiento por lotes o el script de la aplicación. La ruta debe apuntar a un archivo válido.
--display-name(cadena)-
El nombre que se usará para la aplicación en el catálogo de aplicaciones. Si no especifica un nombre de visualización, AppStream 2.0 crea un nombre que se deriva del nombre del archivo ejecutable. El nombre se crea sin la extensión de archivo y con guiones bajos en lugar de espacios. La longitud máxima es de 256 caracteres.
--absolute-icon-path(cadena)-
La ruta completa para el icono de la aplicación. La ruta debe apuntar a un archivo de icono válido de uno de los siguientes tipos: .jpg, .png o .bmp. Las dimensiones máximas son: 256 px x 256 px. Si no especifica una ruta, se utiliza el icono predeterminado del archivo ejecutable, si está disponible. Si el archivo ejecutable no tiene un icono predeterminado, se utiliza un icono predeterminado de aplicación de AppStream 2.0.
--working-directory(cadena)-
El directorio de trabajo inicial de la aplicación cuando se lanza.
--absolute-manifest-path(cadena)-
La ruta de un archivo de texto nuevo delimitado por líneas. El archivo especifica las rutas absolutas de los archivos que se deben optimizar antes de que la instancia de la flota esté disponible para un usuario mediante streaming. La ruta debe apuntar a un archivo de texto válido.
Mensajes de salida
| Código de salida | Mensaje que se muestra en la salida estándar | Descripción |
|---|---|---|
| 0 | {"status": 0, "message": "Success"} | La aplicación se añadió correctamente. |
| 1 | {"status": 1, "message": "Administrator privileges are required to perform this operation"} | Se necesitan privilegios de administrador para llevar a cabo la operación. |
| 1 | {"status": 1, "message": "Unable to add more than 50 apps to the catalog."} | La aplicación no se ha podido añadir porque el número máximo de aplicaciones que se pueden añadir al catálogo de aplicaciones de AppStream 2.0 es de 50. |
| 1 | {"status": 1, "message": "Name is not unique"} | Ya existe una aplicación con ese nombre en el catálogo de aplicaciones de AppStream 2.0. |
| 1 | {"status": 1, "message": "File not found (absolute-app-path)"} | No es posible encontrar el archivo especificado para absolute-app-path. |
| 1 | {"status": 1, "message": "Unsupported file extension"} | El parámetro Absolute-app-path solo es compatible con los siguientes tipos de archivos: .exe y .bat. |
| 1 | {"status": 1, "message": "Directory not found (working-directory)" | No es posible encontrar el directorio especificado para working-directory. |
| 1 | {"status": 1, "message": "Optimization-manifest not found: <filename>"} | No es posible encontrar el archivo especificado para optimization-manifest. |
| 1 | {"status": 1, "message": "File not found: <filename>"} | No es posible encontrar un archivo especificado en el manifiesto de optimización. |
| 255 | {"status": 255, "message": <mensaje de error>} | Se ha producido un error inesperado. Intente volver a realizar la solicitud. Si el error persiste, póngase en contacto con AWS Support para obtener ayuda. Para obtener más información, consulte el Centro de AWS Support |
remove-applicationOperación de
Elimina una aplicación de la lista de aplicaciones para la imagen de AppStream 2.0. La aplicación no se desinstala ni se modifica, pero los usuarios no podrán lanzarla desde el catálogo de aplicaciones de AppStream 2.0.
Sinopsis
remove-application --name <value>
Opciones
--name(cadena)-
El identificador único de la aplicación que se va a eliminar.
Mensajes de salida
| Código de salida | Mensaje que se muestra en la salida estándar | Descripción |
|---|---|---|
| 0 | {"status": 0, "message": "Success"} | La aplicación se ha eliminado correctamente. |
| 1 | {"status": 1, "message": "Administrator privileges are required to perform this operation"} | Se necesitan privilegios de administrador para llevar a cabo la operación. |
| 1 | {"status": 1, "message": "App not found"} | La aplicación que se ha especificado no se ha encontrado en el catálogo de aplicaciones de AppStream 2.0. |
| 255 | {"status": 255, "message": <mensaje de error>} | Se ha producido un error inesperado. Intente volver a realizar la solicitud. Si el error persiste, póngase en contacto con AWS Support para obtener ayuda. Para obtener más información, consulte el Centro de AWS Support |
list-applicationsOperación de
Muestra una lista de todas las aplicaciones especificadas en el catálogo de aplicaciones.
Sinopsis
list-applications
Mensajes de salida
| Código de salida | Mensaje que se muestra en la salida estándar | Descripción |
|---|---|---|
| 0 | {"status": 0, "message": "Success", "applications": [ {..app1.. }, { ..app2.. }]} | Lista de las aplicaciones del catálogo de aplicaciones de AppStream 2.0. |
| 255 | {"status": 255, "message": <mensaje de error>} | Se ha producido un error inesperado. Intente volver a realizar la solicitud. Si el error persiste, póngase en contacto con AWS Support para obtener ayuda. Para obtener más información, consulte el Centro de AWS Support |
update-default-profileOperación de
Copia el perfil de usuario de Windows especificado en el perfil de usuario predeterminado de Windows. Los usuarios nuevos que utilicen el streaming heredan la configuración almacenada en el perfil especificado.
nota
La herramienta de la CLI del asistente de imágenes de Linux no admite esta operación.
Sinopsis
update-default-profile [--profile <value>]
Opciones
--profile(cadena)-
El nombre del usuario cuyo perfil de Windows se copiará en el perfil de usuario predeterminado de Windows. Utilice el formato siguiente para el nombre:
"<dominio>\<nombre-de-usuario>"
Si el generador de imágenes no se ha unido a un dominio de Microsoft Active Directory, escriba un punto "." para el dominio. Si no especifica un usuario, se utiliza la cuenta de usuario de la plantilla de AppStream 2.0.
Mensajes de salida
| Código de salida | Mensaje que se muestra en la salida estándar | Descripción |
|---|---|---|
| 0 | {"status": 0, "message": "Success"} | La configuración de usuario se ha copiado correctamente al perfil predeterminado de Windows. |
| 1 | {"status": 1, "message": "Administrator privileges are required to perform this operation"} | Se necesitan privilegios de administrador para llevar a cabo la operación. |
| 1 | {"status": 1, "message": "Unable to copy file or folder: <path>. <reason>"} | La configuración de usuario no se pudo copiar porque un archivo o carpeta no estaba disponible. |
| 1 | {"status": 1, "message": "Cannot copy a domain user when not joined to a domain""} | Se ha especificado un usuario de un dominio de Microsoft Active Directory, pero el generador de imágenes no se ha unido a un dominio de Active Directory. |
| 255 | {"status": 255, "message": <mensaje de error>} | Se ha producido un error inesperado. Intente volver a realizar la solicitud. Si el error persiste, póngase en contacto con AWS Support para obtener ayuda. Para obtener más información, consulte el Centro de AWS Support |
reset-user-profileOperación de
Elimina el perfil de usuario de Windows para el usuario especificado.
nota
La herramienta de la CLI del asistente de imágenes de Linux no admite esta operación.
Sinopsis
reset-user-profile [--profile <value>]
Opciones
--profile(cadena)-
El nombre del usuario de Windows cuyo perfil de Windows se eliminará. Utilice el formato siguiente para el nombre:
"<dominio>\<nombre-de-usuario>"
Si el generador de imágenes no se ha unido a un dominio de Microsoft Active Directory, escriba un punto "." para el dominio.
Mensajes de salida
| Código de salida | Mensaje que se muestra en la salida estándar | Descripción |
|---|---|---|
| 0 | {"status": 0, "message": "Success"} | Se ha eliminado correctamente la configuración del usuario especificado. |
| 1 | {"status": 1, "message": "Administrator privileges are required to perform this operation"} | Se necesitan privilegios de administrador para llevar a cabo la operación. |
| 1 | {"status": 1, "message": "Unable to copy file or folder: <path>. <reason>"} | La configuración del usuario no se pudo restablecer porque un archivo o carpeta no estaba disponible. |
| 1 | {"status": 1, "message": "Cannot copy a domain user when not joined to a domain""} | Se ha especificado un usuario de un dominio de Microsoft Active Directory, pero el generador de imágenes no se ha unido a un dominio de Active Directory. |
| 255 | {"status": 255, "message": <mensaje de error>} | Se ha producido un error inesperado. Intente volver a realizar la solicitud. Si el error persiste, póngase en contacto con AWS Support para obtener ayuda. Para obtener más información, consulte el Centro de AWS Support |
create-imageOperación de
Inicia el flujo de trabajo de creación de imágenes, lo que da como resultado una imagen de AppStream 2.0 que se puede utilizar para las flotas de AppStream 2.0.
Sinopsis
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]
Opciones
--name(cadena)-
Nombre de la imagen de AppStream 2.0. El nombre debe ser único en una región de AWS y de una cuenta de Amazon Web Services. La longitud máxima es de 100 caracteres. Los caracteres permitidos son:
a-z, A-Z, 0-9, guiones bajos (_), guiones (-) y puntos (.)
El nombre de la imagen no puede comenzar por ninguno de los siguientes prefijos: "aws', "appstream" y "amazon". Estos prefijos están reservados para uso de AWS.
--description(cadena)-
La descripción que se va a mostrar para la imagen. La longitud máxima es de 256 caracteres.
--display-name(cadena)-
El nombre que se va a mostrar para la imagen. La longitud máxima es de 256 caracteres.
--enable-dynamic-app-catalog|--no-enable-dynamic-app-catalog-
Habilita o deshabilita la compatibilidad con el marco de aplicaciones dinámicas de AppStream 2.0. Si no especifica uno de los parámetros, la compatibilidad con el marco de aplicaciones dinámicas no está habilitada.
El marco de aplicaciones dinámicas proporciona operaciones en una instancia de streaming de AppStream 2.0 que se pueden utilizar para crear un proveedor de aplicaciones dinámicas. Los proveedores de aplicaciones dinámicas pueden utilizar estas operaciones para modificar el catálogo de aplicaciones al que los usuarios pueden tener acceso en tiempo real. Para obtener más información, consulte Uso del marco de aplicaciones dinámicas de AppStream 2.0 para crear un proveedor de aplicaciones dinámicas.
--use-latest-agent-version|--no-use-latest-agent-version-
Especifica si se debe asignar la imagen a la versión del agente de AppStream 2.0 que está instalada actualmente, o si se utilizará siempre la versión más reciente del agente. Si no especifica ninguno de los parámetros, la imagen se asocia a la versión del agente de AppStream 2.0 que está instalada actualmente. Para obtener más información, consulte Administración de versiones del agente de AppStream 2.0.
--tags(cadena)-
Las etiquetas que se deben asociar a la imagen. Una etiqueta es un par clave-valor. Use el siguiente formato:
--tags "miclave" "mivalor" "miclave2" "mivalor2"
Para obtener más información acerca de las etiquetas, consulte Etiquetado de los recursos de Amazon AppStream 2.0.
--dry-run(cadena)-
Realiza la validación sin crear la imagen. Utilice este comando para identificar si la imagen tiene algún problema antes de crearla.
Mensajes de salida
| Código de salida | Mensaje que se muestra en la salida estándar | Descripción |
|---|---|---|
| 0 | {"status": 0, "message": "Success"} | El flujo de trabajo para crear la imagen se inició correctamente. |
| 1 | {"status": 1, "message": "Administrator privileges are required to perform this operation"} | Se necesitan privilegios de administrador para llevar a cabo la operación. |
| 1 | {"status": 1, "message": "An image with the given name already exists"} | Ya existe una imagen con el nombre especificado en la cuenta de Amazon Web Services. |
| 1 | {"status": 1, "message": "Invalid value (tags)"} | Las etiquetas especificadas no son válidas. |
| 255 | {"status": 255, "message": <mensaje de error>} | Se ha producido un error inesperado. Intente volver a realizar la solicitud. Si el error persiste, póngase en contacto con AWS Support para obtener ayuda. Para obtener más información, consulte el Centro de AWS Support |
