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

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

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 funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

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

AWS CLI

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

En el siguiente create-monitor ejemplo, se crea un monitor Example_NetworkMonitor con un nombre aggregationPeriod establecido en 30 segundos. La inicial state del monitor se INACTIVE debe a que no hay sondas asociadas a él. 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: Para crear un monitor de red con una sonda que también incluya etiquetas TCP

En el siguiente create-monitor ejemplo, se crea un monitor denominadoExample_NetworkMonitor. El comando también crea una sonda que utiliza el ICMP protocolo e incluye etiquetas. Como no aggregationPeriod se pasa en la solicitud, los 60 segundos se establecen como valores predeterminados. El state del monitor con la sonda será el mismo PENDING hasta que el monitor lo esté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: Para crear un monitor de red con una sonda que también incluya etiquetas ICMP

En el siguiente create-monitor ejemplo, se crea un monitor denominado Example_NetworkMonitor con un aggregationPeriod número de 30 segundos. El comando también crea una sonda que usa el ICMP protocolo e incluye etiquetas. Como no aggregationPeriod se pasa en la solicitud, los 60 segundos se establecen como valores predeterminados. El state del monitor con la sonda será el mismo PENDING hasta que el monitor lo esté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 API obtener más información, consulte CreateMonitorla Referencia de AWS CLI comandos.

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

AWS CLI

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

En el siguiente create-probe ejemplo, se crea una sonda que utiliza la sonda TCP protocol y la añade a un monitor denominadoExample_NetworkMonitor. Una vez creado, el tamaño state del monitor con la sonda será PENDING igual al del monitorACTIVE. 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: Para crear una sonda que utilice una sonda ICMP y añadirla a un monitor de red

En el siguiente create-probe ejemplo, se crea una sonda que utiliza la sonda ICMP protocol y la añade a un monitor denominadoExample_NetworkMonitor. Una vez creado, el tamaño state del monitor con la sonda será PENDING igual al del monitorACTIVE. 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 API obtener más información, consulte CreateProbela Referencia de AWS CLI comandos.

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

AWS CLI

Para eliminar un monitor

En el siguiente delete-monitor ejemplo, se elimina un monitor denominadoExample_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 API obtener más información, consulte DeleteMonitorla Referencia de AWS CLI comandos.

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

AWS CLI

Para eliminar una sonda

En el siguiente delete-probe ejemplo, se elimina una sonda con el ID probe-12345 de un monitor de red denominadoExample_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 API obtener más información, consulte DeleteProbela Referencia de AWS CLI comandos.

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

AWS CLI

Para obtener información sobre el monitor

En el siguiente get-monitor ejemplo se obtiene información sobre un monitor denominadoExample_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 API obtener más información, consulte GetMonitorla Referencia de AWS CLI comandos.

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

AWS CLI

Para ver los detalles de la sonda

El siguiente get-probe ejemplo devuelve detalles sobre una sonda con el nombre probeID probe-12345 que está asociado a un monitorExample_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 API obtener más información, consulte GetProbela Referencia de AWS CLI comandos.

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

AWS CLI

Ejemplo 1: Para enumerar todos los monitores (un solo monitor)

El siguiente list-monitors ejemplo devuelve una lista de un solo monitor. El monitor state es ACTIVE y tiene un tiempo 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: Para enumerar todos los monitores (varios monitores)

El siguiente list-monitors ejemplo devuelve una lista de tres monitores. El state de un monitor es el ACTIVE generador de CloudWatch métricas. Los estados de los otros dos monitores son INACTIVE y no generan CloudWatch métricas. Los tres monitores utilizan una duración 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 API obtener más información, consulte ListMonitorsla Referencia de AWS CLI comandos.

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

AWS CLI

Para enumerar las etiquetas de un recurso

El siguiente list-tags-for-resource ejemplo devuelve una lista de las etiquetas de un monitor denominadoExample_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 API obtener más información, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

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

AWS CLI

Para etiquetar un recurso

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

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 API obtener más información, consulte TagResourcela Referencia de AWS CLI comandos.

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

AWS CLI

Para quitar la etiqueta de un recurso

En el siguiente untag-resource ejemplo, se elimina un tag-keys parámetro con el par clave-valor Environment Application de su asociación con un monitor denominado. 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 API obtener más información, consulte UntagResourcela Referencia de AWS CLI comandos.

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

AWS CLI

Para actualizar un monitor

En el siguiente update-monitor ejemplo, se cambia el tamaño 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 API obtener más información, consulte UpdateMonitorla Referencia de AWS CLI comandos.

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

AWS CLI

Para actualizar una sonda

El siguiente update-probe ejemplo actualiza la dirección destination IP original de una sonda y también actualiza la dirección packetSize de60.

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 API obtener más información, consulte UpdateProbela Referencia de AWS CLI comandos.