Cómo usar la utilidad apigee-adminapi.sh

Edge for Private Cloud v4.18.05

Usa la utilidad apigee-adminapi.sh para realizar las mismas tareas de configuración de Edge que realizas con llamadas a la API de Edge Management. La ventaja de la apigee-adminapi.sh es que:

• Usa una interfaz de línea de comandos simple
• Implementa la finalización de comandos basados en tabulaciones
• Proporciona información de uso y ayuda
• Puede mostrar la llamada a la API correspondiente si decides probar la API.

La utilidad apigee-adminapi.sh no reemplaza al de apigee-provision. En realidad, la utilidad apigee-provision usa el apigee-adminapi.sh para realizar sus tareas.

Estas son las principales diferencias entre ambos:

• La utilidad apigee-adminapi.sh realiza funciones atómicas que reemplazan llamadas individuales a la API de Edge. Por ejemplo, para crear una organización, un entorno y host requiere tres comandos apigee-adminapi.sh separados correspondientes a tres Llamadas a la API.
• La utilidad apigee-provision está diseñada para realizar un análisis completo de alto nivel con un solo comando. Por ejemplo, puedes crear una organización, un entorno y virtual con un solo comando apigee-provision pasando un archivo de configuración con toda la información necesaria.

En la documentación de Edge, se usan ambas utilidades cuando corresponde.

Instala apigee-adminapi.sh

La utilidad apigee-adminapi.sh se instala automáticamente cuando instalas el apigee-provision o la utilidad apigee-validate.

La utilidad está instalada en la siguiente ubicación:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Sintaxis de /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

La utilidad apigee-adminapi.sh usa una sintaxis de línea de comandos simple. En cualquier momento, utiliza la tecla Tab para mostrar un mensaje en el que se indiquen las opciones de comando disponibles.

Para ver todos los comandos posibles, invoca la utilidad sin opciones:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Si presionas la tecla Tab después de escribir apigee-adminapi.sh, verás la lista de posibles Opciones:

analytics  classification  logsessions  regions  securityprofile  userroles
buildinfo  GET             orgs         runtime  servers          users

La tecla Tab muestra opciones según el contexto del comando. Si ingresas la tecla Tab después de escribir:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Verás las opciones posibles para completar el comando orgs:

add  apis  apps  delete  envs  list  pods  userroles

Usa la opción -h para mostrar la ayuda de cualquier comando. Por ejemplo, si utilizas el -h, como se muestra a continuación:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -h

La utilidad muestra información de ayuda completa para todas las opciones posibles al Comando orgs. El primer elemento del resultado muestra la ayuda de la Comando orgs add:

+++++++++++++++++++++++++++++++++++++++++++
orgs add
  Required:
    -o ORG Organization name
  Optional:
    -H HEADER add http header in request
    --admin ADMIN_EMAIL admin email address
    --pwd ADMIN_PASSWORD admin password
    --host EDGE_SERVER edge server to make request to
    --port EDGE_PORT port to use for the http request
    --ssl set EDGE_PROTO to https, defaults to http
    --debug ( set in debug mode, turns on verbose in curl )
    -h      Displays Help

Parámetros de configuración con interruptores de línea de comandos y variables de entorno

Debes ingresar todos los parámetros en un comando mediante interruptores de línea de comandos o variables de entorno. Agrega el prefijo de un solo guion (-) o dos guiones a los interruptores de la línea de comandos. (--) según sea necesario.

Por ejemplo, en el cuadro de ayuda que aparece arriba para la frase "organizaciones que agregan" , puedes especificar la nombre de la organización de alguna de las siguientes maneras:

• Con el interruptor de línea de comandos de -o, haz lo siguiente:

  /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg

• Configura una variable de entorno llamada ORG:

  > export ORG=testOrg
  /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Si omites algún parámetro obligatorio del comando, la utilidad muestra un mensaje de error. al describir los parámetros faltantes. Por ejemplo, si omites --host o La variable de entorno EDGE_SERVER que especifica el servidor de administración perimetral cuando se crea en una organización, verás el siguiente mensaje de error:

Error with required variable or parameter
ADMIN_PASSWORD....OK
ADMIN_EMAIL....OK
EDGE_SERVER....null

Dos parámetros comunes que a menudo configuras como variables de entorno son el correo electrónico del administrador del sistema y la dirección IP del servidor de administración:

export ADMIN_EMAIL=foo@bar.com
export EDGE_SERVER=192.168.56.101

Pasa un archivo a apigee-adminapi.sh servicio

Algunos comandos de utilidad de apigee-adminapi.sh corresponden a las llamadas a la API de PUT y POST que toman un cuerpo de solicitud. Por ejemplo, crear una instancia host corresponde a una llamada a la API de POST que requiere información sobre el host virtual en la del cuerpo de la solicitud.

Cuando uses la utilidad apigee-adminapi.sh para crear un host virtual, o cualquier comando que tome el cuerpo de una solicitud, puedes pasar todos los la información necesaria en la línea de comandos, como se muestra a continuación:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005

También puedes pasar un archivo que contenga la misma información que aparece en la solicitud. cuerpo de la POST. Por ejemplo, el siguiente comando toma un archivo que define el host virtual:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate

Donde el archivo vhostcreate contiene el cuerpo POST de la llamada. En este ejemplo, es un cuerpo de solicitud con formato XML:

<VirtualHost name="myVHostUtil">
   <HostAliases>
     <HostAlias>192.168.56.101:9005</HostAlias>
   </HostAliases>
   <Interfaces/>
   <Port>9005</Port>
</VirtualHost>

Cómo mostrar información de depuración y de la API

Usa la opción --debug para la utilidad apigee-adminapi.sh a fin de mostrarla información detallada sobre el comando. Esta información incluye el comando curl generado por la utilidad apigee-adminapi.sh para realizar la operación.

Por ejemplo, este comando usa la opción --debug:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug

Y muestra el siguiente resultado, incluido el comando curl generado:

curl -H Content-Type: application/xml -v -X POST     -s -k -w \n==> %{http_code}
-u ***oo@bar.com:*****     http://localhost:8080/v1/o -d <Organization name="testOrg2" 
type="paid"/>
* About to connect() to localhost port 8080 (#0)
*   Trying ::1... connected
* Connected to localhost (::1) port 8080 (#0)
* Server auth using Basic with user 'foo@bar.com'
> POST /v1/o HTTP/1.1
> Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1
Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: localhost:8080
> Accept: */*
> Content-Type: application/xml
> Content-Length: 43
>
} [data not shown]
< HTTP/1.1 201 Created
< Content-Type: application/json
< Date: Tue, 03 May 2016 02:08:32 GMT
< Content-Length: 291
<
{ [data not shown]
* Connection #0 to host localhost left intact
* Closing connection #0