Administra una puerta de enlace segura

En esta página, se explica cómo completar tareas comunes de administración de la puerta de enlace segura.

Configura tu entorno de shell

Para optimizar el proceso de configuración y, luego, interactuar con las APIs de la puerta de enlace segura, define las siguientes variables de entorno en tu shell de trabajo.

  • Parámetros generales

    API="beyondcorp.googleapis.com"
    API_VERSION=v1
    PROJECT_ID=PROJECT_ID
    APPLICATION_ID=APPLICATION_ID
    APPLICATION_DISPLAY_NAME="APPLICATION_DISPLAY_NAME"
    HOST_NAME=HOST_NAME

    Reemplaza lo siguiente:

    • PROJECT_ID: Es el ID del proyecto en el que se crea la puerta de enlace segura.
    • APPLICATION_ID: Es el ID de tu aplicación, como github. El nombre puede tener hasta 63 caracteres y puede contener letras minúsculas, números y guiones. El primer carácter debe ser una letra y el último puede ser una letra o un número.
    • APPLICATION_DISPLAY_NAME: Es el nombre legible que se mostrará.
    • HOST_NAME: Es el nombre de host de tu aplicación. Por ejemplo, github.com. El nombre de host puede tener hasta 253 caracteres y debe cumplir con uno de los siguientes formatos:

      • Una dirección IPv4 válida
      • Una dirección IPv6 válida
      • Un nombre de DNS válido
      • Un asterisco (*)
      • Un asterisco (*) seguido de un nombre de DNS válido
  • Parámetros de la puerta de enlace segura

    SECURITY_GATEWAY_ID=SECURITY_GATEWAY_ID
    SECURITY_GATEWAY_DISPLAY_NAME="SECURITY_GATEWAY_DISPLAY_NAME"

    Reemplaza lo siguiente:

    • SECURITY_GATEWAY_ID: Es el ID de la puerta de enlace segura. El ID puede tener hasta 63 caracteres y puede contener letras en minúscula, números y guiones. El primer carácter debe ser una letra y el último puede ser una letra o un número.
    • SECURITY_GATEWAY_DISPLAY_NAME: Es el nombre legible de la puerta de enlace segura. El nombre puede tener hasta 63 caracteres y solo puede contener caracteres imprimibles.

Actualiza una puerta de enlace segura

En el siguiente ejemplo, se muestra cómo actualizar los centros de una puerta de enlace segura existente.

gcloud

gcloud beyondcorp security-gateways update ${SECURITY_GATEWAY_ID} \
  --project=${PROJECT_ID} \
  --location=global \
  --hubs=us-central1,us-east1
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X PATCH \
-d "{ \"hubs\": {\"us-central1\": {}, \"us-east1\": {}} }" \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}?update_mask=hubs"
      

Obtén los detalles de una puerta de enlace segura

Para obtener los detalles de una puerta de enlace segura, ejecuta el siguiente comando.

gcloud

gcloud beyondcorp security-gateways describe ${SECURITY_GATEWAY_ID} \
  --project=${PROJECT_ID} \
  --location=global
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}"
      

Enumera las puertas de enlace seguras

Para enumerar todas las puertas de enlace seguras de un proyecto, ejecuta el siguiente comando.

gcloud

gcloud beyondcorp security-gateways list \
  --project=${PROJECT_ID} \
  --location=global
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways"
      

Borra una puerta de enlace segura

Para borrar una puerta de enlace segura, ejecuta el siguiente comando.

gcloud

gcloud beyondcorp security-gateways delete ${SECURITY_GATEWAY_ID} \
  --project=${PROJECT_ID} \
  --location=global
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X DELETE \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}"
      

Actualiza un recurso de la aplicación

En el siguiente ejemplo, se muestra cómo actualizar una aplicación existente. Entre los campos editables permitidos, se incluyen los siguientes:

  • display_name
  • endpoint_matchers

Puedes usar update_mask para controlar qué campos se actualizan. En el siguiente ejemplo, se muestra cómo actualizar el campo endpoint_matchers:

gcloud

gcloud beyondcorp security-gateways applications update ${APPLICATION_ID} \
  --project=${PROJECT_ID} \
  --security-gateway=${SECURITY_GATEWAY_ID} \
  --location=global \
  --endpoint-matchers="hostname=${HOST_NAME},ports=[443]"
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X PATCH \
-d "{ \"endpoint_matchers\": [{hostname: \"${HOST_NAME}\", ports: [443]}] }" \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications/${APPLICATION_ID}?update_mask=endpoint_matchers"
      

Obtén los detalles de un recurso de aplicación

Para obtener los detalles de una aplicación, ejecuta el siguiente comando.

gcloud

gcloud beyondcorp security-gateways applications describe ${APPLICATION_ID} \
  --project=${PROJECT_ID} \
  --security-gateway=${SECURITY_GATEWAY_ID} \
  --location=global
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications/${APPLICATION_ID}"
      

Enumera los recursos de la aplicación

Para enumerar todas las aplicaciones en una puerta de enlace de seguridad, ejecuta el siguiente comando.

gcloud

gcloud beyondcorp security-gateways applications list \
  --project=${PROJECT_ID} \
  --security-gateway=${SECURITY_GATEWAY_ID} \
  --location=global
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications"
      

Borra un recurso de aplicación

Para borrar una aplicación, ejecuta el siguiente comando.

gcloud

gcloud beyondcorp security-gateways applications delete ${APPLICATION_ID} \
  --project=${PROJECT_ID} \
  --security-gateway=${SECURITY_GATEWAY_ID} \
  --location=global
      

REST

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-X DELETE \
"https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications/${APPLICATION_ID}"