Exemples d’utilisation de l’AWS CLI avec CloudWatch Network Monitoring

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec CloudWatch Network Monitoring.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

Actions

L’exemple de code suivant montre comment utiliser create-monitor.

AWS CLI

Exemple 1 : pour créer un moniteur réseau avec une période d’agrégation

L’exemple create-monitor suivant crée un moniteur nommé Example_NetworkMonitor avec une aggregationPeriod de 30 secondes. L’state initial du moniteur sera INACTIVE, car aucune sonde n’y est associée. L’état passe à ACTIVE uniquement lorsque des sondes sont ajoutées. Vous pouvez utiliser les commandes update-monitor ou create-probe pour ajouter des sondes à ce moniteur.


aws networkmonitor create-monitor \
     --monitor-name Example_NetworkMonitor \
     --aggregation-period 30

Sortie :


{
    "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "INACTIVE",
    "aggregationPeriod": 30,
    "tags": {}
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Exemple 2 : pour créer un moniteur réseau avec une sonde utilisant le protocole TCP et incluant également des balises

L’exemple create-monitor suivant crée un moniteur nommé Example_NetworkMonitor. La commande crée également une sonde qui utilise le protocole ICMP et inclut des balises. Puisque aucune aggregationPeriod n’est transmise dans la demande, 60 secondes est la valeur par défaut. L’state du moniteur avec la sonde sera PENDING jusqu’à ce que le moniteur soit ACTIVE. Cela peut prendre plusieurs minutes, puis la valeur state deviendra ACTIVE, et vous pourrez commencer à consulter les métriques CloudWatch.


aws networkmonitor create-monitor \
    --monitor-name Example_NetworkMonitor \
    --probes sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,probeTags={Name=Probe1} \
    --tags Monitor=Monitor1

Sortie :


{
    "monitorArn": "arn:aws:networkmonitor:region111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 60,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Exemple 3 : pour créer un moniteur réseau avec une sonde utilisant ICMP et incluant également des balises

L’exemple create-monitor suivant crée un moniteur nommé Example_NetworkMonitor avec une aggregationPeriod de 30 secondes. La commande crée également une sonde qui utilise le protocole ICMP et inclut des balises. Puisque aucune aggregationPeriod n’est transmise dans la demande, 60 secondes est la valeur par défaut. L’state du moniteur avec la sonde sera PENDING jusqu’à ce que le moniteur soit ACTIVE. Cela peut prendre plusieurs minutes, puis la valeur state deviendra ACTIVE, et vous pourrez commencer à consulter les métriques CloudWatch.


aws networkmonitor create-monitor \
     --monitor-name Example_NetworkMonitor \
     --aggregation-period 30 \
     --probes sourceArn=arn:aws:ec2:region111122223333:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,probeTags={Name=Probe1} \
     --tags Monitor=Monitor1

Sortie :


{
    "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 30,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez CreateMonitor dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-probe.

AWS CLI

Exemple 1 : pour créer une sonde utilisant le protocole TCP et l’ajouter à un moniteur réseau

L’exemple create-probe suivant crée une sonde qui utilise le protocol TCP et ajoute la sonde à un moniteur nommé Example_NetworkMonitor. Une fois créé, l’state du moniteur avec la sonde sera PENDING jusqu’à ce que le moniteur soit ACTIVE. Cela peut prendre plusieurs minutes, puis l’état deviendra ACTIVE, et vous pourrez commencer à consulter les métriques CloudWatch.


aws networkmonitor create-probe \
    --monitor-name Example_NetworkMonitor \
    --probe sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,tags={Name=Probe1}

Sortie :


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345",
    "destination": "10.0.0.100",
    "destinationPort": 80,
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T12:41:57.314000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Exemple 2 : pour créer une sonde utilisant ICMP et l’ajouter à un moniteur réseau

L’exemple create-probe suivant crée une sonde qui utilise le protocol ICMP et ajoute la sonde à un moniteur nommé Example_NetworkMonitor. Une fois créé, l’state du moniteur avec la sonde sera PENDING jusqu’à ce que le moniteur soit ACTIVE. Cela peut prendre plusieurs minutes, puis l’état deviendra ACTIVE, et vous pourrez commencer à consulter les métriques CloudWatch.


aws networkmonitor create-probe \
    --monitor-name Example_NetworkMonitor \
    --probe sourceArn=arn:aws:ec2:region:012345678910:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,tags={Name=Probe1}

Sortie :


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345",
    "destination": "10.0.0.100",
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:44:02.452000-04:00",
    "modifiedAt": "2024-03-29T12:44:02.452000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez CreateProbe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-monitor.

AWS CLI

Pour supprimer un moniteur

L’exemple delete-monitor suivant supprime un moniteur nommé Example_NetworkMonitor.


aws networkmonitor delete-monitor \
    --monitor-name Example_NetworkMonitor

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez DeleteMonitor dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-probe.

AWS CLI

Pour supprimer une sonde

L’exemple delete-probe suivant supprime une sonde portant l’ID probe-12345 d’un moniteur réseau nommé Example_NetworkMonitor.


aws networkmonitor delete-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez DeleteProbe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-monitor.

AWS CLI

Pour obtenir les informations sur le moniteur

L’exemple get-monitor suivant fournit les informations sur un moniteur nommé Example_NetworkMonitor.


aws networkmonitor get-monitor \
    --monitor-name Example_NetworkMonitor

Sortie :


{
    "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "ACTIVE",
    "aggregationPeriod": 60,
    "tags": {},
    "probes": [],
    "createdAt": "2024-04-01T17:58:07.211000-04:00",
    "modifiedAt": "2024-04-01T17:58:07.211000-04:00"
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez GetMonitor dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-probe.

AWS CLI

Pour afficher des informations sur la sonde

L’exemple get-probe suivant renvoie les informations sur une sonde avec l’probeID probe-12345 associée à un moniteur nommé Example_NetworkMonitor.


aws networkmonitor get-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345

Sortie :


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345",
    "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345",
    "destination": "10.0.0.100",
    "destinationPort": 80,
    "protocol": "TCP",
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "ACTIVE",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T12:42:28.610000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez GetProbe dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-monitors.

AWS CLI

Exemple 1 : pour répertorier tous les moniteurs (moniteur unique)

L’exemple list-monitors suivant renvoie une liste d’un seul moniteur. L’state du moniteur est ACTIVE avec une aggregationPeriod de 60 secondes.


aws networkmonitor list-monitors

Sortie :


{
    "monitors": [{
            "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
            "monitorName": "Example_NetworkMonitor",
            "state": "ACTIVE",
            "aggregationPeriod": 60,
            "tags": {
                "Monitor": "Monitor1"
            }
        }
    ]
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Exemple 2 : pour répertorier tous les moniteurs (plusieurs moniteurs)

L’exemple list-monitors suivant renvoie une liste de trois moniteurs. L’state d’un moniteur est ACTIVE et il génère des métriques CloudWatch. Les états des deux autres moniteurs sont INACTIVE et ils ne génèrent pas de métriques CloudWatch. Les trois moniteurs ont une aggregationPeriod de 60 secondes.


aws networkmonitor list-monitors

Sortie :


{
    "monitors": [
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor",
            "monitorName": "Example_NetworkMonitor",
            "state": "INACTIVE",
            "aggregationPeriod": 60,
            "tags": {}
        },
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor2",
            "monitorName": "Example_NetworkMonitor2",
            "state": "ACTIVE",
            "aggregationPeriod": 60,
            "tags": {
                "Monitor": "Monitor1"
            }
        },
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/TestNetworkMonitor_CLI",
            "monitorName": "TestNetworkMonitor_CLI",
            "state": "INACTIVE",
            "aggregationPeriod": 60,
            "tags": {}
        }
    ]
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez ListMonitors dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-tags-for-resource.

AWS CLI

Pour répertorier les balises d’une ressource

L’exemple list-tags-for-resource suivant renvoie une liste des balises d’un moniteur nommé Example_NetworkMonitor.


aws networkmonitor list-tags-for-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor

Sortie :


{
    "tags": {
        "Environment": "Dev",
        "Application": "PetStore"
    }
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez ListTagsForResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser tag-resource.

AWS CLI

Pour baliser une ressource

L’exemple tag-resource suivant ajoute des balises Environment=Dev et Application=PetStore à un moniteur nommé Example_NetworkMonitor.


aws networkmonitor tag-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \
    --tags Environment=Dev,Application=PetStore

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez TagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser untag-resource.

AWS CLI

Pour supprimer une balise d’une ressource

L’exemple untag-resource suivant supprime un paramètre tag-keys avec la paire clé-valeur de l’Environment Application de son association avec un moniteur nommé Example_NetworkMonitor.


aws networkmonitor untag-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \
    --tag-keys Environment Application

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez UntagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-monitor.

AWS CLI

Pour mettre à jour un moniteur

L’exemple update-monitor suivant fait passer la aggregationPeriod d’un moniteur de 60 secondes à 30 secondes.


aws networkmonitor update-monitor \
    --monitor-name Example_NetworkMonitor \
    --aggregation-period 30

Sortie :


{
    "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 30,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez UpdateMonitor dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-probe.

AWS CLI

Pour mettre à jour une sonde

L’exemple update-probe suivant met à jour l’adresse IP destination d’origine d’une sonde et met également à jour la packetSize sur 60.


aws networkmonitor update-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345 \
    --destination 10.0.0.150 \
    --packet-size 60

Sortie :


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345",
    "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345",
    "destination": "10.0.0.150",
    "destinationPort": 80,
    "protocol": "TCP",
    "packetSize": 60,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T13:52:23.115000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Pour plus d’informations, consultez Fonctionnement d’Amazon CloudWatch Network Monitor dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez UpdateProbe dans la Référence des commandes de l’AWS CLI.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

CloudWatch Logs

CloudWatch Observability Access Monitor