Visión general de la herramienta de línea de mandatos

Editar en línea

IBM® API Connect kit de herramientas de desarrollador proporciona mandatos para la administración de nube y el desarrollo y la gestión de API.

Sintaxis del mandato

Por lo general, los mandatos tienen la sintaxis siguiente:

apic command:sub-command [argument] [options]

donde

mandato es el mandato, normalmente aquello sobre lo que se actúa (por ejemplo producto, aplicación, API, catálogos, etc.).
submandato es la acción que se va a realizar.
argumento es el argumento, cuando procede (por ejemplo catalog).
Las opciones son cualquier número de opciones de línea de mandatos, que tienen el formato --option [value]. Las opciones también tienen un formato abreviado con un solo guión en lugar de un guión doble.

Por ejemplo, apic apps:publish --server mgmnthost.com.

Para algunos mandatos o bien el mandato, o bien la parte del submandato es opcional. Por ejemplo:

apic products:publish es equivalente a apic publish.
apic products:list es equivalente a apic products.

El mandato create tiene una sintaxis ligeramente diferente:

apic create:type [options]

Utilice la opción -h o --help para ver la ayuda del mandato.

Nota: El idioma en el que se visualiza el texto de ayuda de CLI, y otro texto de respuesta de mandato, viene determinado por el valor de entorno local en la máquina local.

Visualización de la ayuda de la herramienta de línea de mandatos

Visualice la información general de ayuda de línea de mandatos especificando el mandato siguiente: apic --help o apic -h. Visualice información de ayuda para un mandato apic específico especificando el mandato siguiente: apic command_name --help o apic command_name -h.

Visualización de la información de versión

Visualice la versión de la herramienta de línea de mandatos especificando el mandato apic --version.

Utilización de variables de configuración

Puede establecer los valores de propiedades utilizadas habitualmente en variables de configuración. En general es más fácil y coherente establecer variables de configuración en lugar de especificarlas mediante opciones de línea de mandatos.

Nota:

Las variables de configuración de los proyectos de OpenAPI son siempre globales. Los valores de las variables de configuración globales se almacenan en el user-home-dir/.apiconnect/config archivo, donde «directorio_de_inicio_del_usuario» es el directorio de inicio del usuario.

Utilice los mandatos siguientes para trabajar con variables de configuración:

apic config:get varname -Obtener una variable de configuración. Utilice apic config para visualizar los valores de todas las variables de configuración local o apic config -g para visualizar los valores de todas las variables de configuración global.
apic config:set varname -Establecer o actualizar la variable de configuración especificada.
apic config:delete varname -Suprimir la variable de configuración especificada.
apic config:clear: suprimir todas las variables de configuración.

Puede establecer los valores de propiedad de configuración mediante el mandato apic config:set. Al establecer propiedades de configuración (por ejemplo catalog y app), no es necesario proporcionar valores para estas opciones cuando especifica un mandato.

También puede utilizar mandatos de apic properties para trabajar con propiedades de configuración:

apic properties:clear: borrar las propiedades de configuración.
apic properties:create: aumentar las propiedades de configuración con pares nombre/valor adicionales.
apic properties:delete: suprimir la propiedad de configuración.
apic properties:get: obtener la propiedad de configuración.
apic properties:list: listar las propiedades de configuración.
apic properties:update: actualizar la propiedad de configuración.

Nota:

Si tiene una variable de entorno con el mismo nombre que una propiedad de configuración de la CLI, de forma predeterminada, su valor alterará temporalmente el valor de la propiedad de configuración de la CLI correspondiente para cualquier mandato de CLI de ese ámbito.

Por ejemplo, si ha definido una variable de entorno denominada SPACE, de forma predeterminada, se asumirá ese valor para el valor del parámetro --space en el mandato siguiente, independientemente de cualquier valor de propiedad de configuración space:

apic products:publish my_product.yaml --scope space

Para evitar que las variables de entorno alteren temporalmente las propiedades de configuración de la CLI, defina una variable de entorno denominada APIC_LOAD_FROM_ENV, establecida en el valor false.

En la tabla siguiente se describen las variables de configuración:

Tabla 1. Variables de configuración
Nombre de variable	Descripción	Utilizar en lugar de (o sustituir por) estos distintivos...
catálogo	Nombre predeterminado del catálogo para todos los comandos que gestionan aspectos de un catálogo. El valor del catálogo se puede especificar de las siguientes maneras: La URI completa del catálogo, que incluye el nombre del servidor y el nombre de la organización: `mgmt-server/api/catalogs/org-name/catalog-name`. En este caso, no es necesario especificar `--catalog`, `--organization`, o `--server` al realizar llamadas a la CLI, ya que sus valores están incluidos en la URI completa del catálogo. El nombre del catálogo, por ejemplo: `sandbox`. En este caso, sigue siendo necesario especificar `--organization` y `--server` al realizar llamadas desde la CLI. Nota: El nombre de catálogo `apic-dev` está reservado para las pruebas locales.	Si se utiliza el URI del catálogo en la asignación de variables: `--catalog, --organization, --server` Si se utiliza el nombre del catálogo en la asignación de variables: `--catalog`
nube	Nombre de host de servidor de gestión predeterminado para mandatos de administración de nube. Formulario: `mgmt-server/api/`.	`--server`
consumidor	URI predeterminado de un consumidor de API. Formulario: `mgmt-server/api/consumer-orgs/org-name/catalog-name/consumer-org-name`, donde `mgmt-server` es el servidor de gestión, `org-name` es el nombre de la organización, `catalog-name` es el nombre del catálogo y `consumer-org-name` es el nombre de la organización de consumidores.	`-–server, -–organization, -–catalog, -–consumer`
modo	El valor predeterminado del parámetro `--mode` para mandatos de CLI. Establezca el valor en `apim` o `consumer` en función de si desea ejecutar mandatos en una organización de proveedores o una organización de consumidores. Si no establece esta variable y no proporciona un parámetro `--mode` en un mandato, se presupone el valor `apim`.	--mode
org	Nombre predeterminado de la organización para todos los comandos que gestionan organizaciones. Formulario: `mgmt-server/api/orgs/org-name`, donde `mgmt-server` es el servidor de gestión, `org-name` es el nombre de la organización. El valor «org» se puede especificar de las siguientes formas: El URI completo de la organización, que incluye el nombre del servidor: `mgmt-server/api/orgs/org-name`. En este caso, no es necesario especificar `--server` ni `--organization` al realizar llamadas a la CLI, ya que sus valores están incluidos en la URI completa de la organización. El nombre de la organización, por ejemplo: `providerorg1`. En este caso, sigue siendo necesario especificarlo `--server` cuando realices llamadas a la CLI.	Si se utiliza el URI de la organización en la asignación de variables: `--organization, --server` Si se utiliza el nombre de la organización en la asignación de una variable: `--organization`
Espacio	URI de Espacio predeterminado para todos los mandatos que gestionan aspectos de un Espacio. Formulario: `mgmt-server/api/spaces/org-name/catalog-name/space-name`, donde `mgmt-server` es el servidor de gestión, `org-name` es el nombre de organización, `catalog-name` es el nombre de catálogo y `space-name` es el nombre de Espacio . Puede añadir el número de puerto al nombre de servidor mientras no se trate del valor predeterminado 443.	`--server, --organization, --catalog, --space`

Para establecer las propiedades de configuración, especifique el mandato siguiente:

apic config:set name=value

donde nombre es el nombre de la propiedad de configuración y valor el valor que se le va a asignar.

Por ejemplo:

apic config:set catalog=sandbox

Creación de scripts de mandatos

A menudo resulta útil automatizar una serie de mandatos apic en un script shell. Puesto que la herramienta apic requiere primero que acepte interactivamente la licencia, debe utilizar primero el mandato siguiente:

apic --accept-license

Una vez que lo haga, los scripts se pueden ejecutar sin necesidad de interacción.

Para inhabilitar la recopilación de análisis de uso, especifique este mandato:

apic --live-help

Ajustar el idioma

Puede configurar el idioma para las salidas de comandos CLI utilizando el indicador ' --lang '. Esta bandera permite que el kit de herramientas de desarrollo proporcione salidas de comandos en el idioma especificado. La siguiente tabla contiene los idiomas admitidos:

Tabla 2. Idiomas disponibles
Valor lingüístico	Idioma
es-es	Inglés (EE.UU.)
cs	Checo
de	Alemán
es	Español
es	Francés
it	Italiano
ja	Japonés
ko	Coreano
nl	Holandés
pl	Polaco
pt-br	Portugués (Brasil)
ru	Ruso
tr	Turco
zh-cn	Chino (Simplificado)
zh-tw	Chino (Tradicional)

Utiliza valores lingüísticos en función de tus necesidades. Utilice el francés como ejemplo. Para establecer el idioma en francés, ejecute el siguiente comando:

apic --lang fr

Tras ejecutar el comando, los resultados se muestran en francés. Por ejemplo:

apic config get invalid
Error: invalid n'est pas une variable de configuration valide

Cuando proporciona un valor no válido que no es un idioma admitido, el sistema muestra el siguiente error:

apic --lang invalid
Error: Value invalid is not valid for lang. Valid values are: en-us, cs, de, es, fr, it, ja, ko, nl, pl, pt-br, ru, tr, zh-cn, zh-tw