Opções de linha de comando do agente de transferência
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Os agentes de transferência transferem dados do sistema de arquivos para o Google Cloud. Quando
você executar um agente, é possível controlar as opções dele por meio
das sinalizações e opções descritas nesta página.
Exclui o contêiner e o sistema de arquivos dele quando o Docker é encerrado.
Para mais informações, consulte
Limpeza (--rm) (em inglês)
-v host-directory:container-directory
Especifica
um ou mais volumes (em inglês) a
serem mapeados do host para o contêiner. Ao usar -v, é necessário
que host-directory
e container-directory sejam iguais. Caso contrário,
o Serviço de transferência do Cloud Storage não localizará os arquivos para transferência.
Especifica uma variável de ambiente para o contêiner do Docker. Use esta sinalização para
configurar seus agentes e usar um proxy de encaminhamento. Para mais informações, consulte
Como usar um proxy de encaminhamento.
Opções do agente
--agent-id-prefix=id-prefix
Um prefixo opcional que é anexado ao ID do agente para ajudar a identificar o
agente ou a máquina no console Google Cloud . Quando um prefixo é usado, o
ID do agente é formatado como prefix + hostname + Docker container ID.
--creds-file=credential-file
Um arquivo de credencial de conta de serviço no formato JSON opcional. Para mais
informações sobre como gerar um arquivo de credencial da conta de serviço, consulte
Como criar e gerenciar chaves da conta de serviço.
--enable_mount_directory
Como alternativa, ative todo o sistema de arquivos no diretório
/transfer_root do contêiner do Docker, em vez de especificar
ativações de volume -v do Docker (em inglês)
individuais.
Ao usar essa sinalização, não é necessário adicionar o prefixo /transfer_root
ao diretório de registros ou ao caminho do arquivo de credenciais da conta de serviço. Além disso,
/transfer_root não é visível em registros de transferência ou amostras
de erro de GUI.
--help
Exibe uma breve ajuda de uso.
--hostname=hostname
Define o nome do host em que o agente está sendo executado. Usado para informar o nome do host
da máquina em que um determinado agente está sendo executado.
--log-dir=logs-directory
Um diretório opcional em que o agente grava registros. O diretório padrão
é /tmp/.
--max-physical-mem=maximum-memory
Por padrão, os agentes usam no máximo 8 GiB de memória do sistema. Se isso
não se encaixar no seu ambiente, será possível especificar um uso máximo de memória
relevante nos seguintes formatos:
Valor de max-physical-mem
Configuração máxima de memória
6g
6 gigabytes
6gb
6 gigabytes
6GiB
6 gibibytes
--project-id=project-id
String obrigatória do ID do projeto que hospeda os recursos de transferência que foram criados e faturados.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-18 UTC."],[],[],null,["# Transfer agent command-line options\n\nTransfer agents transfer data from your file system to Google Cloud. You\ncan control agent options when you run an\nagent through the flags and options described in this page.\n\nCommand summary\n---------------\n\n```\nsudo docker run [--ulimit memlock=64000000 -d --rm -v host-directory:container-directory]\n--env environment-variable=variable-value\ngcr.io/cloud-ingest/tsop-agent:latest\n{--help | --version | --project-id=project-id}\n[--agent-id-prefix=id-prefix --creds-file=credential-file\n--enable_mount_directory --hostname=hostname\n--log-dir=logs-directory\n--max-physical-mem=maximum-memory]\n```\n\nDocker options\n--------------\n\n`--ulimit memlock=64000000`\n: Locks shared memory for a shared pool for Docker, so that it is always in\n memory for access by multiple sessions.\n\n`-d`\n\n: Starts the Docker container in detached mode, or in the background. This\n allows you to continue issuing commands from the Linux terminal.\n\n For more information, see\n [Detached -d](https://docs.docker.com/engine/reference/run/#detached--d)\n\n`--rm`\n\n: Deletes the container and the container's file system when Docker exits.\n\n For more information, see\n [Clean up (--rm)](https://docs.docker.com/engine/reference/run/#clean-up---rm)\n\n`-v `\u003cvar translate=\"no\"\u003ehost-directory\u003c/var\u003e`:`\u003cvar translate=\"no\"\u003econtainer-directory\u003c/var\u003e\n\n: Specifies one or more\n [volumes](https://docs.docker.com/storage/volumes/) to\n map from the host to the container. When using `-v`, we require\n the \u003cvar translate=\"no\"\u003ehost-directory\u003c/var\u003e\n and \u003cvar translate=\"no\"\u003econtainer-directory\u003c/var\u003e to be the same, otherwise\n Storage Transfer Service won't successfully locate your files for transfer.\n\n For more information, see\n [VOLUME (shared file systems)](https://docs.docker.com/engine/reference/run/#volume-shared-filesystems)\n\n`--env `\u003cvar translate=\"no\"\u003eenvironment-variable\u003c/var\u003e`=`\u003cvar translate=\"no\"\u003evariable-value\u003c/var\u003e\n\n: Specifies an environment variable for the Docker container. Use this flag to\n configure your agents to use a forward proxy. For more information, see\n [Using a forward proxy](/storage-transfer/docs/on-prem-agent-details#using-forward-proxy).\n\nAgent options\n-------------\n\n`--agent-id-prefix=`\u003cvar translate=\"no\"\u003eid-prefix\u003c/var\u003e\n: An optional prefix that is prepended to the agent ID to help identify the\n agent or its machine in the Google Cloud console. When a prefix is used, the\n agent ID is formatted as `prefix + hostname + Docker container ID`.\n\n`--creds-file=`\u003cvar translate=\"no\"\u003ecredential-file\u003c/var\u003e\n\n: An optional JSON-formatted service account credential file. For more\n information about generating a service account credential file, see\n [creating and managing service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).\n\n | **Note:** Unless you are using `--enable_mount_directory`, you must prefix this path with `/transfer_root`, for example `/transfer_root/path/to/cred_file.json`.\n\n`--enable_mount_directory`\n\n: Optionally mounts the whole file system under the directory\n `/transfer_root` within the Docker container, rather than\n specifying individual\n [Docker `-v`volume mounts](https://docs.docker.com/storage/volumes/).\n When using this flag, you don't need to prefix `/transfer_root`\n to the log directory or the service account credentials file path, and\n `/transfer_root` isn't visible in transfer logs or GUI error\n samples.\n\n`--help`\n\n: Displays brief usage help.\n\n`--hostname=`\u003cvar translate=\"no\"\u003ehostname\u003c/var\u003e\n\n: set the hostname that the agent is running on. Used to report the hostname\n of the machine a particular agent is running on.\n\n | **Note:** We recommend passing `--hostname=$(hostname)` when using this flag.\n\n`--log-dir=`\u003cvar translate=\"no\"\u003elogs-directory\u003c/var\u003e\n\n: An optional directory that the agent writes logs to. The default directory\n is `/tmp/`.\n\n | **Note:** Unless you are using `--enable_mount_directory`, you must prefix this path with `/transfer_root`, for example, `/transfer/root/path/to/log_file`.\n\n`--max-physical-mem=`\u003cvar translate=\"no\"\u003emaximum-memory\u003c/var\u003e\n\n: Agents default to using 8GiB maximum of system memory. If the default\n doesn't fit your environment, you can specify a relevant maximum memory\n usage in the following formats:\n\n`--project-id=`\u003cvar translate=\"no\"\u003eproject-id\u003c/var\u003e\n\n: Required string of the project ID that is hosting the transfer resources that are created and billed.\n\n`--version`\n\n: Displays the current version of the agent."]]
