CloudWatch Ejemplos de monitorización de redes utilizando AWS CLI - AWS Ejemplos de código de SDK
Acciones

Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de ejemplos de AWS Doc SDK.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CloudWatch Ejemplos de monitorización de redes utilizando AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el uso de la AWS Command Line Interface supervisión CloudWatch de red.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar create-monitor.

AWS CLI

Ejemplo 1: crear un monitor de red con un período de agregación

En el siguiente ejemplo de create-monitor se crea un monitor llamado Example_NetworkMonitor con aggregationPeriod establecido en 30 segundos. El state inicial del monitor será INACTIVE porque no tiene sondas asociadas. El estado cambia a ACTIVE solo cuando se agregan sondas. Puede utilizar los comandos update-monitor o create-probe para añadir sondas a este monitor.

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

Salida:

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

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

Ejemplo 2: crear un monitor de red con una sonda utilizando TCP y que también incluya etiquetas

El siguiente ejemplo de create-monitor crea un monitor llamado Example_NetworkMonitor. El comando también crea una sonda que usa el protocolo ICMP e incluye etiquetas. Dado que no se pasa aggregationPeriod en la solicitud, se establece 60 segundos como valor predeterminado. El state del monitor con la sonda será PENDING hasta que el monitor sea ACTIVE. Esto puede tardar varios minutos, momento en el que state pasará a serACTIVE, y podrás empezar a ver CloudWatch las métricas.

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

Salida:

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

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

Ejemplo 3: crear un monitor de red con una sonda utilizando ICMP y que también incluya etiquetas

En el siguiente ejemplo de create-monitor se crea un monitor llamado Example_NetworkMonitor con un aggregationPeriod de 30 segundos. El comando también crea una sonda que usa el protocolo ICMP e incluye etiquetas. Dado que no se pasa aggregationPeriod en la solicitud, se establece 60 segundos como valor predeterminado. El state del monitor con la sonda será PENDING hasta que el monitor sea ACTIVE. Esto puede tardar varios minutos, momento en el que state pasará a serACTIVE, y podrás empezar a ver CloudWatch las métricas.

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

Salida:

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

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte CreateMonitorla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar create-probe.

AWS CLI

Ejemplo 1: crear una sonda que utilice TCP y añadirla a un monitor de red

En el siguiente ejemplo de create-probe se crea una sonda que utiliza el protocol TCP y añade la sonda a un monitor llamado Example_NetworkMonitor. Una vez creado, el state del monitor con la sonda será PENDING hasta que el monitor sea ACTIVE. Esto puede tardar varios minutos, momento en el que el estado cambiará aACTIVE, y podrás empezar a ver CloudWatch las métricas.

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}

Salida:

{
    "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"
    }
}

Ejemplo 2: crear una sonda que utilice sondeo con ICMP y añadirla a un monitor de red

En el siguiente ejemplo de create-probe se crea una sonda que utiliza el protocol ICMP y añade la sonda a un monitor llamado Example_NetworkMonitor. Una vez creado, el state del monitor con la sonda será PENDING hasta que el monitor sea ACTIVE. Esto puede tardar varios minutos, momento en el que el estado cambiará aACTIVE, y podrás empezar a ver CloudWatch las métricas.

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}

Salida:

{
    "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"
    }
}

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte CreateProbela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-monitor.

AWS CLI

Para eliminar un monitor

En el siguiente ejemplo de delete-monitor se elimina un monitor llamado Example_NetworkMonitor.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte DeleteMonitorla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-probe.

AWS CLI

Para eliminar una sonda

En el siguiente ejemplo de delete-probe se elimina una sonda con el ID probe-12345 de un monitor de red llamado Example_NetworkMonitor.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte DeleteProbela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar get-monitor.

AWS CLI

Para obtener información del monitor

En el siguiente ejemplo de get-monitor se obtiene información sobre un monitor llamado Example_NetworkMonitor.

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

Salida:

{
    "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"
}

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte GetMonitorla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar get-probe.

AWS CLI

Para ver los detalles de sondas

En el siguiente ejemplo de get-probe se devuelven detalles sobre una sonda con el probeID probe-12345 que está asociado a un monitor llamado Example_NetworkMonitor.

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

Salida:

{
    "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"
    }
}

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte GetProbela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar list-monitors.

AWS CLI

Ejemplo 1: enumerar todos los monitores (solo único)

En el siguiente ejemplo de list-monitors se devuelve una lista de un solo monitor. El state del monitor es ACTIVE y tiene un aggregationPeriod de 60 segundos.

aws networkmonitor list-monitors

Salida:

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

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

Ejemplo 2: enumerar todos los monitores (varios monitores)

En el siguiente ejemplo de list-monitors se devuelve una lista de tres monitores. Lo state de un monitor es ACTIVE generar CloudWatch métricas. Los estados de los otros dos monitores son INACTIVE y no generan CloudWatch métricas. Los tres monitores utilizan un aggregationPeriod de 60 segundos.

aws networkmonitor list-monitors

Salida:

{
    "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": {}
        }
    ]
}

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte ListMonitorsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar list-tags-for-resource.

AWS CLI

Para enumerar las etiquetas de un recurso

En el siguiente ejemplo de list-tags-for-resource se devuelve una lista de las etiquetas de un monitor llamado Example_NetworkMonitor.

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

Salida:

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

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

Para etiquetar un recurso

En el siguiente ejemplo de tag-resource se etiqueta un monitor llamado Example_NetworkMonitor con etiquetas Environment=Dev y Application=PetStore.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte TagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

Para retirar la etiqueta de un recurso

En el siguiente ejemplo de untag-resource se elimina un parámetro tag-keys con el par clave-valor de Environment Application de su asociación con un monitor llamado Example_NetworkMonitor.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte UntagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar update-monitor.

AWS CLI

Para actualizar un monitor

En el siguiente ejemplo de update-monitor se cambia el aggregationPeriod de un monitor de 60 segundos a 30 segundos.

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

Salida:

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

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte UpdateMonitorla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar update-probe.

AWS CLI

Para actualizar una sonda

En el siguiente ejemplo de update-probe se actualiza la dirección IP de destination original de una sonda y también se actualiza el packetSize a 60.

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

Salida:

{
    "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"
    }
}

Para obtener más información, consulte Cómo funciona Amazon CloudWatch Network Monitor en la Guía del CloudWatch usuario de Amazon.

  • Para obtener más información sobre la API, consulte UpdateProbela Referencia de AWS CLI comandos.