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

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 de comandos

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.

Establecimiento de la modalidad

La CLI del kit de herramientas de API Connect ejecuta mandatos en la organización de proveedores o en la organización de consumidores. Cuando ejecuta el mandato, puede utilizar diferentes opciones de mode para identificar la instancia en la que desea ejecutar el mandato. La lista siguiente proporciona un resumen de las modalidades disponibles:
apim
Esta modalidad se aplica a las instancias administrativas de la CLI. Cuando ejecuta mandatos en esta modalidad, utiliza el Gestor de API global como ámbito. Esta modalidad es la predeterminada.
Un ejemplo de ejecución la ejecución de un mandato en la modalidad apim:
apic extensions:list-all --mode apim --scope catalog --server server1 --catalog catalog1 --org myOrg --configured-gateway-service service1
portaladmin
Esta modalidad se aplica a las instancias del portal del desarrollador de la CLI. Esta modalidad admite mandatos que puede utilizar para replicar todo el entorno del Portal del desarrollador o parte de él.
Un ejemplo de ejecución la ejecución de un mandato en la modalidad portaladmin:
apic --mode portaladmin custom-theme:create-export --catalog catalog1 --org myOrg --server server1 --format json
consumer
Esta modalidad se aplica a las instancias de consumidor de la CLI. Este mandato utiliza como ámbito las organizaciones de consumidores para las que tiene permiso para acceder. Debe especificar esta modalidad o establecerla como el valor predeterminado para que el mandato la utilice.
Un ejemplo de ejecución la ejecución de un mandato en la modalidad consumer:
apic catalogs:list --mode consumer --scope catalog --server server1 --catalog catalog1 --org myOrg
Para evitar tener que proporcionar el parámetro en cada mandato de CLI de consumidor, puede establecer la variable de configuración mode tal como se describe en la sección siguiente.

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 para proyectos OpenAPI siempre son globales. Los valores de las variables de configuración globales se almacenan en el archivo user-home-dir/.apiconnect/config , donde user-home-dir 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 de catálogo predeterminado para todos los mandatos que gestionan aspectos de un catálogo.
El valor de catálogo se puede especificar como:
  • El URI de catálogo completo que incluye el nombre de servidor y el nombre de organización: mgmt-server/api/catalogs/org-name/catalog-name. En este caso, no es necesario que especifique --catalog, --organizationo --server cuando realice llamadas de CLI, ya que sus valores se incluyen en el URI de catálogo completo.
  • El nombre del catálogo, por ejemplo: sandbox. En este caso, todavía tiene que especificar --organization y --server cuando realice llamadas de CLI.
Nota: El nombre de catálogo apic-dev está reservado para las pruebas locales.
  • Si se utiliza el URI de catálogo en la asignación de variables: --catalog, --organization, --server
  • Si se utiliza el nombre de catálogo en la asignación de variables: --catalog
cloud 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 de organización predeterminado para todos los mandatos 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 de organización se puede especificar como:
  • El URI de organización completo que incluye el nombre de servidor: mgmt-server/api/orgs/org-name. En este caso, no es necesario especificar --server o --organization al realizar llamadas de CLI, ya que sus valores se incluyen en el URI de organización completo.
  • El nombre de la organización, por ejemplo: providerorg1. En este caso, todavía tiene que especificar --server cuando realice llamadas de CLI.
  • Si el URI de la organización se utiliza en la asignación de variables: --organization, --server
  • Si se utiliza el nombre de organización en la asignación de variables: --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 soportados
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 se proporciona un valor no válido que no es un idioma soportado, 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