send-command

Описание

Выполняет команды на одном или нескольких управляемых узлах.

См. также: Документацию AWS API

Синтаксис

  send-command
[--instance-ids <value>]
[--targets <value>]
--document-name <value>
[--document-version <value>]
[--document-hash <value>]
[--document-hash-type <value>]
[--timeout-seconds <value>]
[--comment <value>]
[--parameters <value>]
[--output-s3-region <value>]
[--output-s3-bucket-name <value>]
[--output-s3-key-prefix <value>]
[--max-concurrency <value>]
[--max-errors <value>]
[--service-role-arn <value>]
[--notification-config <value>]
[--cloud-watch-output-config <value>]
[--alarm-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--instance-ids (список)

Синтаксис:

"string" "string" ...

--targets (список)

Сокращенный синтаксис:

Key=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--document-name (строка)

--document-version (строка)

--document-hash (строка)

--document-hash-type (строка)

--timeout-seconds (целое число)

--comment (строка)

--parameters (карта)

Сокращенный синтаксис:

KeyName1=string,string,KeyName2=string,string

Синтаксис JSON:

{"string": ["string", ...]
  ...}

--output-s3-region (строка)

--output-s3-bucket-name (строка)

--output-s3-key-prefix (строка)

--max-concurrency (строка)

--max-errors (строка)

--service-role-arn (строка)

--notification-config (структура)

Сокращенный синтаксис:

NotificationArn=string,NotificationEvents=string,string,NotificationType=string

Синтаксис JSON:

{
  "NotificationArn": "string",
  "NotificationEvents": ["All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed", ...],
  "NotificationType": "Command"|"Invocation"
}

--cloud-watch-output-config (структура)

Сокращенный синтаксис:

CloudWatchLogGroupName=string,CloudWatchOutputEnabled=boolean

Синтаксис JSON:

{
  "CloudWatchLogGroupName": "string",
  "CloudWatchOutputEnabled": true|false
}

--alarm-configuration (структура)

Сокращенный синтаксис:

IgnorePollAlarmFailure=boolean,Alarms=[{Name=string},{Name=string}]

Синтаксис JSON:

{
  "IgnorePollAlarmFailure": true|false,
  "Alarms": [
    {
      "Name": "string"
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись в журнал.

--endpoint-url (строка)

Переопределить значение URL по умолчанию команды на указанный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

• json
• text
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла аутентификационных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию данного инструмента.

--color (строка)

Включить/выключить цветной вывод.

• on
• off
• auto

--no-sign-request (логическое значение)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод для кли-пейджера.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Пример 1: Чтобы запустить команду на одном или нескольких удалённых экземплярах

Следующий send-command пример запускает команду echo на целевом экземпляре.

aws ssm send-command \
    --document-name "AWS-RunShellScript" \
    --parameters 'commands=["echo HelloWorld"]' \
    --targets "Key=instanceids,Values=i-1234567890abcdef0" \
    --comment "echo HelloWorld"

Вывод:

{
    "Command": {
        "CommandId": "92853adf-ba41-4cd6-9a88-142d1EXAMPLE",
        "DocumentName": "AWS-RunShellScript",
        "DocumentVersion": "",
        "Comment": "echo HelloWorld",
        "ExpiresAfter": 1550181014.717,
        "Parameters": {
            "commands": [
                "echo HelloWorld"
            ]
        },
        "InstanceIds": [
            "i-0f00f008a2dcbefe2"
        ],
        "Targets": [],
        "RequestedDateTime": 1550173814.717,
        "Status": "Pending",
        "StatusDetails": "Pending",
        "OutputS3BucketName": "",
        "OutputS3KeyPrefix": "",
        "MaxConcurrency": "50",
        "MaxErrors": "0",
        "TargetCount": 1,
        "CompletedCount": 0,
        "ErrorCount": 0,
        "DeliveryTimedOutCount": 0,
        "ServiceRole": "",
        "NotificationConfig": {
            "NotificationArn": "",
            "NotificationEvents": [],
            "NotificationType": ""
        },
        "CloudWatchOutputConfig": {
            "CloudWatchLogGroupName": "",
            "CloudWatchOutputEnabled": false
        }
    }
}

Дополнительную информацию см. в разделе «Запуск команд с помощью Systems Manager Run Command» в Руководстве пользователя AWS Systems Manager.

Пример 2: Чтобы получить информацию об IP-адресе экземпляра

Следующий send-command пример извлекает информацию об IP-адресе экземпляра.

aws ssm send-command \
    --instance-ids "i-1234567890abcdef0" \
    --document-name "AWS-RunShellScript" \
    --comment "IP config" \
    --parameters "commands=ifconfig"

См. пример 1 для примера вывода.

Дополнительную информацию см. в разделе «Запуск команд с помощью Systems Manager Run Command» в Руководстве пользователя AWS Systems Manager.

Пример 3: Чтобы запустить команду на экземплярах со специфическими тегами

Следующий send-command пример запускает команду на экземплярах, имеющих ключ тега «ENV» и значение «Dev».

aws ssm send-command \
    --targets "Key=tag:ENV,Values=Dev" \
    --document-name "AWS-RunShellScript" \
    --parameters "commands=ifconfig"

См. пример 1 для примера вывода.

Дополнительную информацию см. в разделе «Запуск команд с помощью Systems Manager Run Command» в Руководстве пользователя AWS Systems Manager.

Пример 4: Чтобы запустить команду, которая отправляет уведомления SNS

Следующий send-command пример запускает команду, которая отправляет уведомления SNS для всех событий уведомления и типа уведомления Command.

aws ssm send-command \
    --instance-ids "i-1234567890abcdef0" \
    --document-name "AWS-RunShellScript" \
    --comment "IP config" \
    --parameters "commands=ifconfig" \
    --service-role-arn "arn:aws:iam::123456789012:role/SNS_Role" \
    --notification-config "NotificationArn=arn:aws:sns:us-east-1:123456789012:SNSTopicName,NotificationEvents=All,NotificationType=Command"

См. пример 1 для примера вывода.

Дополнительную информацию см. в разделе «Запуск команд с помощью Systems Manager Run Command» в Руководстве пользователя AWS Systems Manager.

Пример 5: Чтобы запустить команду, которая выводит данные в S3 и CloudWatch

Следующий send-command пример запускает команду, которая выводит сведения о команде в ведро S3 и в группу журналов CloudWatch Logs.

aws ssm send-command \
    --instance-ids "i-1234567890abcdef0" \
    --document-name "AWS-RunShellScript" \
    --comment "IP config" \
    --parameters "commands=ifconfig" \
    --output-s3-bucket-name "s3-bucket-name" \
    --output-s3-key-prefix "runcommand" \
    --cloud-watch-output-config "CloudWatchOutputEnabled=true,CloudWatchLogGroupName=CWLGroupName"

См. пример 1 для примера вывода.

Дополнительную информацию см. в разделе «Запуск команд с помощью Systems Manager Run Command» в Руководстве пользователя AWS Systems Manager.

Пример 6: Чтобы запустить команды на нескольких экземплярах с разными тегами

Следующий send-command пример запускает команду на экземплярах с двумя разными ключами и значениями тегов.

aws ssm send-command \
    --document-name "AWS-RunPowerShellScript" \
    --parameters commands=["echo helloWorld"] \
    --targets Key=tag:Env,Values=Dev Key=tag:Role,Values=WebServers

См. пример 1 для примера вывода.

Дополнительную информацию см. в разделе «Запуск команд с помощью Systems Manager Run Command» в Руководстве пользователя AWS Systems Manager.

Пример 7: Чтобы нацелить несколько экземпляров с одинаковым ключом тега

Следующий send-command пример запускает команду на экземплярах, имеющих одинаковый ключ тега, но с разными значениями.

aws ssm send-command \
    --document-name "AWS-RunPowerShellScript" \
    --parameters commands=["echo helloWorld"] \
    --targets Key=tag:Env,Values=Dev,Test

См. пример 1 для примера вывода.

Дополнительную информацию см. в разделе «Запуск команд с помощью Systems Manager Run Command» в Руководстве пользователя AWS Systems Manager.

Пример 8: Чтобы запустить команду, использующую общий документ

Следующий send-command пример запускает общий документ на целевом экземпляре.

aws ssm send-command \
    --document-name "arn:aws:ssm:us-east-1:123456789012:document/ExampleDocument" \
    --targets "Key=instanceids,Values=i-1234567890abcdef0"

См. пример 1 для примера вывода.

Дополнительную информацию см. в разделе «Использование общих документов SSM» в Руководстве пользователя AWS Systems Manager.

Вывод

Команда -> (структура)