Création manuelle d'OpsItems (AWS CLI) - AWS Systems Manager

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création manuelle d'OpsItems (AWS CLI)

La procédure suivante décrit comment créer un clone OpsItem à l'aide de l'AWS Command Line Interface (AWS CLI).

Pour créer un OpsItem à l'aide du AWS CLI
  1. Si vous ne l'avez pas déjà fait, installez et configurez l'AWS Command Line Interface (AWS CLI).

    Pour de plus amples informations, consultez Installation ou mise à jour de la version la plus récente de l'AWS CLI.

  2. Ouvrez la AWS CLI et exécutez la commande suivante pour créer un OpsItem. Remplacez chaque example resource placeholder (espace réservé pour les ressources) avec vos propres informations.

    aws ssm create-ops-item \ --title "Descriptive_title" \ --description "Information_about_the_issue" \ --priority Number_between_1_and_5 \ --source Source_of_the_issue \ --operational-data Up_to_20_KB_of_data_or_path_to_JSON_file \ --notifications Arn="SNS_ARN_in_same_Region" \ --tags "Key=key_name,Value=a_value"

    Spécifier les données opérationnelles à partir d'un fichier

    Lorsque vous créez un OpsItem, vous pouvez spécifier des données opérationnelles à partir d'un fichier. Le fichier doit être un fichier JSON et le contenu du fichier doit utiliser le format suivant.

    { "key_name": { "Type": "SearchableString", "Value": "Up to 20 KB of data" } }

    Voici un exemple.

    aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 2 ^ --source ec2 ^ --operational-data file:///Users/TestUser1/Desktop/OpsItems/opsData.json ^ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser1" ^ --tags "Key=EC2,Value=Production"
    Note

    Pour plus d'informations sur la saisie de paramètres au format JSON sur la ligne de commande sous différents systèmes d'exploitation locaux, consultez Utilisation de guillemets avec des chaînes dans la AWS CLI dans le Guide de l'utilisateur AWS Command Line Interface.

    Le système retourne des informations telles que les suivantes.

    {
        "OpsItemId": "oi-1a2b3c4d5e6f"
    }
  3. Maintenant, exécutez la commande suivante pour afficher les détails relatifs à l'OpsItem que vous avez créé.

    aws ssm get-ops-item --ops-item-id ID

    Le système retourne des informations telles que les suivantes.

    {
        "OpsItem": {
            "CreatedBy": "arn:aws:iam::12345678:user/TestUser",
            "CreatedTime": 1558386334.995,
            "Description": "Log clean up may have failed which caused the disk to be full",
            "LastModifiedBy": "arn:aws:iam::12345678:user/TestUser",
            "LastModifiedTime": 1558386334.995,
            "Notifications": [
                {
                    "Arn": "arn:aws:sns:us-west-1:12345678:TestUser"
                }
            ],
            "Priority": 2,
            "RelatedOpsItems": [],
            "Status": "Open",
            "OpsItemId": "oi-1a2b3c4d5e6f",
            "Title": "EC2 instance disk full",
            "Source": "ec2",
            "OperationalData": {
                "EC2": {
                    "Value": "12345",
                    "Type": "SearchableString"
                }
            }
        }
    }
  4. Exécutez la commande suivante pour mettre à jour une tâche OpsItem. Cette commande modifie le statut de Open (la valeur par défaut) et le remplace par InProgress.

    aws ssm update-ops-item --ops-item-id ID --status InProgress

    La commande n'a aucune sortie.

  5. Exécutez à nouveau la commande suivante pour vérifier que le statut est passé à InProgress.

    aws ssm get-ops-item --ops-item-id ID

Exemples de création d'un OpsItem

Les exemples de code suivants vous montrent comment créer un OpsItem à l'aide du portail de gestion Linux, macOS ou Windows.

Portail de gestion Linux ou macOS

La commande suivante crée un OpsItem quand un disque d'instance Amazon Elastic Compute Cloud (Amazon EC2) est plein.

aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"EC2":{"Value":"12345","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser1" \ --tags "Key=EC2,Value=ProductionServers"

La commande suivante utilise la clé /aws/resources dans OperationalData pour créer un OpsItem avec une ressource Amazon DynamoDB connexe.

aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"/aws/resources":{"Value":"[{\"arn\": \"arn:aws:dynamodb:us-west-2:12345678:table/OpsItems\"}]","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser"

La commande suivante utilise la clé /aws/automations dans OperationalData pour créer un OpsItem qui spécifie le document AWS-ASGEnterStandby en tant que runbook Automation associé.

aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 2 \ --source ec2 \ --operational-data '{"/aws/automations":{"Value":"[{\"automationId\": \"AWS-ASGEnterStandby\", \"automationType\": \"AWS::SSM::Automation\"}]","Type":"SearchableString"}}' \ --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser"

Windows

La commande suivante crée un OpsItem lorsqu'une instance Amazon Relational Database Service (Amazon RDS) ne répond pas.

aws ssm create-ops-item ^ --title "RDS instance not responding" ^ --description "RDS instance not responding to ping" ^ --priority 1 ^ --source RDS ^ --operational-data={\"RDS\":{\"Value\":\"abcd\",\"Type\":\"SearchableString\"}} ^ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser1" ^ --tags "Key=RDS,Value=ProductionServers"

La commande suivante utilise la clé /aws/resources dans OperationalData pour créer un OpsItem avec une ressource connexe de l'instance EC2.

aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 2 ^ --source ec2 ^ --operational-data={\"/aws/resources\":{\"Value\":\"[{\\"""arn\\""":\\"""arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0\\"""}]\",\"Type\":\"SearchableString\"}}

La commande suivante utilise la clé /aws/automations dans OperationalData pour créer un OpsItem qui spécifie le runbook AWS-RestartEC2Instance en tant que runbook Automation associé.

aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 2 ^ --source ec2 ^ --operational-data={\"/aws/automations\":{\"Value\":\"[{\\"""automationId\\""":\\"""AWS-RestartEC2Instance\\”"",\\"""automationType\\""":\\"""AWS::SSM::Automation\\"""}]\",\"Type\":\"SearchableString\"}}