Administra grupos de agentes

Un grupo de agentes es una colección de agentes que usan la misma configuración, con acceso uniforme a tu fuente y destino y visibilidad de ellos. Los grupos de agentes también proporcionan control sobre los límites de ancho de banda de transferencia.

Todos los agentes deben pertenecer a un grupo de agentes.

En esta guía, se describe cómo usar los grupos de agentes.

Antes de comenzar

Debes tener los permisos correctos en tu proyecto para trabajar con los grupos de agentes. Consulta Control de acceso con IAM para obtener más detalles.

Puedes ver tus permisos actuales.

Para usar los comandos de gcloud, instala la herramienta de línea de comandos de gcloud.

Crea un grupo de agentes

Para crear un grupo de agentes, haz lo siguiente:

Google Cloud Console

  1. En la consola, ve a la página Grupos de agentes.

    Ir a los grupos de agentes

    Se mostrará la página Grupos de agentes, que enumera tus grupos de agentes existentes.

  2. Haz clic en Crear otro grupo.

  3. Asigna un nombre a tu grupo y, de manera opcional, una descripción.

  4. Puedes optar por establecer un límite de ancho de banda que se aplicará al grupo en general. El ancho de banda especificado en MB/s se dividirá entre todos los agentes del grupo. Para obtener más información, consulta Administrar el ancho de banda de red.

  5. Haga clic en Crear.

API de REST

Usa projects.agentPools.create:

POST https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{agent_pool_id=AGENT_POOL_ID}:create

Donde:

  • PROJECT_ID: Es el ID del proyecto en el que creas el grupo de agentes.
  • AGENT_POOL_ID: Es el ID del grupo de agentes que creas.

Si un grupo de agentes se detuvo en el estado Creating durante más de 30 minutos, recomendamos borrar el grupo de agentes y volver a crearlo.

Revocar los permisos necesarios del Servicio de transferencia de almacenamiento de un proyecto mientras un grupo de agentes está en el estado Creating genera un comportamiento de servicio incorrecto.

CLI de gcloud

Para crear un grupo de agentes con la herramienta de línea de comandos de gcloud, ejecuta gcloud transfer agent-pools create.

gcloud transfer agent-pools create NAME \
  [--no-async] \
  [--bandwidth-limit=BANDWIDTH_LIMIT] \
  [--display-name=DISPLAY_NAME]

Las siguientes opciones están disponibles:

  • NAME es un identificador único y permanente para este grupo.

  • --no-async bloquea otras tareas en tu terminal hasta que se cree el grupo. Si no se incluye, la creación de grupos se ejecuta de forma asíncrona.

  • --bandwidth-limit define cuánto ancho de banda de MB/s debe estar disponible para los agentes de este grupo. Un límite de ancho de banda se aplica a todos los agentes de un grupo y puede ayudar a evitar que la carga de trabajo de transferencia del grupo interrumpa otras operaciones que comparten el ancho de banda. Por ejemplo, ingresa “50” para establecer un límite de ancho de banda de 50 MB/s. Si dejas esta marca sin especificar, los agentes del grupo usarán todo el ancho de banda disponible para ellos.

  • --display-name es un nombre modificable que te ayuda a identificar este grupo. Puedes incluir detalles que podrían no caber en el nombre completo del recurso del grupo.

Asigna agentes a un grupo

Los grupos de agentes nuevos están vacíos y deben tener agentes asignados. Solo cuando se crea un agente este se puede asignar a un grupo de agentes.

Si no se especifica un grupo de agentes, el agente se asigna al grupo transfer_service_default.

Para crear un agente y asignarlo a un grupo, haz lo siguiente:

Google Cloud Console

  1. En la página Grupos de agentes, selecciona el grupo al que se asignarán los agentes.

  2. Haz clic en Instalar agente. Aparecerá la guía de instalación del agente.

  3. Sigue las instrucciones para crear el agente en este grupo de agentes.

CLI de gcloud

Para usar la herramienta de línea de comandos de gcloud a fin de crear un agente y asignarlo a un grupo, ejecuta gcloud transfer agents install. El agente se debe instalar en una máquina con acceso raíz al sistema de archivos.

gcloud transfer agents install --pool=AGENT_POOL

Consulta Administra agentes de transferencia para obtener más detalles.

Para obtener más opciones, consulta Configuración avanzada del agente.

Para administrar los agentes, consulta Administra agentes de transferencia.

Asigna un grupo de agentes a un trabajo

Una vez que se creó el grupo de agentes, se puede asignar a un trabajo durante la creación o actualización del trabajo.

Actualiza un grupo de agentes

Puedes actualizar el nombre visible y el límite de ancho de banda de un grupo de agentes.

Para actualizar un grupo de agentes, haz lo siguiente:

Google Cloud Console

En la consola, ve a la página Grupos de agentes.

Ir a los grupos de agentes

Puedes editar los siguientes elementos:

  • El nombre visible del grupo de agentes: haz clic en Editar junto al nombre actual del Grupo de agentes.

  • El límite de ancho de banda del grupo de agentes: haz clic en Configurar límite de ancho de banda y, luego, ingresa un límite nuevo en el cuadro de diálogo Configurar límite de ancho de banda. Haz clic en Configurar límite para aplicar el nuevo límite de ancho de banda. El ancho de banda se comparte entre todos los agentes del grupo.

API de REST

Para actualizar un grupo de agentes, usa projects.agentPools.patch con una máscara de campo de los campos que se actualizarán. Se pueden actualizar los siguientes campos del grupo de agentes:

Por ejemplo, para actualizar displayName a my-transfer, debes proporcionar la máscara de campo "displayName,my-transfer".

El siguiente es un ejemplo de una solicitud de parche para actualizar el nombre visible:

PATCH https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{AGENT_POOL_ID}:"displayName,NEW_NAME"

Donde:

  • PROJECT_ID: Es el ID del proyecto en el que actualizas el grupo de agentes.
  • AGENT_POOL_ID: Es el ID del grupo de agentes que deseas actualizar.
  • NEW_NAME: Es el nombre visible nuevo para este grupo de agentes.

El siguiente es un ejemplo de una solicitud de parche para actualizar el límite de ancho de banda:

PATCH https://storagetransfer.googleapis.com/v1/projects/{PROJECT_ID}/agentPools/{AGENT_POOL_ID}:"bandwidthLimit,NEW_LIMIT"

Donde:

  • PROJECT_ID: Es el ID del proyecto en el que actualizas el grupo de agentes.
  • AGENT_POOL_ID: Es el ID del grupo de agentes que deseas actualizar.
  • NEW_LIMIT: Es el nuevo límite de ancho de banda para este grupo de agentes.

CLI de gcloud

Si deseas usar la herramienta de línea de comandos de gcloud para actualizar un grupo de agentes, ejecuta gcloud transfer agent-pools update.

gcloud transfer agent-pools update NAME \
  [--bandwidth-limit=NEW_BANDWIDTH_LIMIT] [--clear-bandwidth-limit] \
  [--clear-display-name] [--display-name=NEW_DISPLAY_NAME]

Se requiere el siguiente argumento:

  • NAME es el identificador permanente y único de este grupo. NAME identifica el grupo de agentes que se actualizará, y no se puede actualizar por sí mismo.

Las siguientes marcas se pueden especificar con este comando:

  • --bandwidth-limit se puede actualizar o quitar si especificas --clear-bandwidth-limit en su lugar. Consulta Crea un grupo de agentes para obtener más detalles sobre los límites de ancho de banda.

  • --display-name se puede actualizar o borrar con la marca --clear-display-name en su lugar.

Borra un grupo de agentes

Puedes borrar un grupo de agentes que no tenga agentes activos ni ejecuciones de trabajos activas.

Para borrar un grupo de agentes, haz lo siguiente:

Google Cloud Console

  1. En la consola, ve a la página Grupos de agentes.

    Ir a los grupos de agentes

  2. Haz clic en Borrar. Lee la ventana emergente y, luego, haz clic en Borrar para confirmar.

    Si el botón de borrar no está activo, deberás detener todos los agentes y trabajos asociados con este grupo.

API de REST

Usa projects.agentPools.delete:

DELETE https://storagetransfer.googleapis.com/v1/{name=PROJECT_ID/*/agentPools/}

Donde:

  • PROJECT_ID: Es el ID del proyecto en el que deseas borrar el grupo de agentes.

CLI de gcloud

Si deseas usar la herramienta de línea de comandos de gcloud para borrar un grupo de agentes, ejecuta gcloud transfer agent-pools delete.

gcloud transfer agent-pools delete NAME

Se requiere el siguiente argumento:

  • NAME es el identificador permanente y único de este grupo.

Antes de borrar un grupo, se deben detener todos los agentes en el grupo, los trabajos del grupo deben estar inhabilitados y no debe haber operaciones de transferencia en curso para este grupo.

Para ver todos los trabajos asociados con un grupo, selecciona tu grupo en Google Cloud Console y haz clic en la pestaña Trabajos de transferencia.

Obtén un grupo de agentes

Para obtener un grupo de agentes, haz lo siguiente:

Google Cloud Console

En la consola, ve a la página Grupos de agentes.

Ir a los grupos de agentes

En la página, se muestra una lista de todos los grupos de agentes asociados con tu proyecto y la siguiente información para cada grupo de agentes:

  • Nombre del grupo de agentes
  • Estado de conexión
  • Cantidad de agentes conectados
  • Límite de ancho de banda, si está configurado
  • Cantidad de trabajos de transferencia asociados
  • El nombre visible del grupo de agentes

Para ver un grupo de agentes específico, haz clic en el Nombre del grupo de agentes.

Las siguientes acciones están disponibles en la página de información de un grupo de agentes:

  • Instalar agente: muestra instrucciones para instalar agentes de transferencia.
  • Detener agente: selecciona un agente en la tabla y haz clic en Detener agente.
  • Enumera los trabajos de transferencia: haz clic en Trabajos de transferencia para mostrar los trabajos de transferencia a los que están conectados los agentes de este grupo.

API de REST

Usa projects.agentPools.get:

GET https://storagetransfer.googleapis.com/v1/{name=PROJECT_ID/*/agentPools/}

Donde:

  • PROJECT_ID: Es el ID del proyecto del que obtienes un grupo de agentes.

CLI de gcloud

Si deseas usar la herramienta de línea de comandos de gcloud para recuperar un grupo de agentes, ejecuta gcloud transfer agent-pools describe.

gcloud transfer agent-pools describe NAME

Se requiere el siguiente argumento:

  • NAME es el identificador permanente y único de este grupo.

Enumera grupos de agentes

Para enumerar tus grupos de agentes, haz lo siguiente:

Google Cloud Console

En la consola, ve a la página Grupos de agentes.

Ir a los grupos de agentes

Se muestran todos los grupos de agentes.

API de REST

Usa projects.agentPools.list:

GET https://storagetransfer.googleapis.com/v1/projects/{project_id=PROJECT_ID}/agentPools

Donde:

  • PROJECT_ID: Es el ID del proyecto del que obtienes un grupo de agentes.

CLI de gcloud

Si quieres usar la herramienta de línea de comandos de gcloud para enumerar los grupos de agentes, ejecuta gcloud transfer agent-pools list.

gcloud transfer agent-pools list \
  [--limit=LIMIT] \
  [--names=[NAMES,...]] \
  [--page-size=PAGE_SIZE]

Las siguientes marcas se pueden especificar con este comando:

  • --limit define la cantidad máxima de grupos de agentes que se mostrarán.

  • --names especifica los nombres de los grupos de agentes que se van a enumerar. Separa varios nombres con comas; por ejemplo, --names=foo,bar. Si no se especifica, se enumeran todos los grupos de agentes de tu proyecto actual.

  • --page-size define el comportamiento de lotes para este comando. De forma predeterminada, el comando list agrupa las respuestas en 256 elementos y recupera el siguiente lote de forma automática hasta que se enumeren todos los elementos o se alcance limit.

El comando muestra una lista de grupos de agentes coincidentes y sus detalles de configuración. En el siguiente ejemplo, se muestra una respuesta.

name: projects/my-project-123/agentPools/my-first-pool
state: CREATED
---
bandwidthLimit:
  limitMbps: '120'
displayName: Source A to destination Z.
name: projects/my-project-123/agentPools/a2z-pool
state: CREATED