calicoctl ipam

This section describes the calicoctl ipam show command.

Read the calicoctl Overview for a full list of calicoctl commands.

Displaying the help text for ‘calicoctl ipam show’ command

Run calicoctl ipam show --help to display the following help menu for the command.

Usage:
  calicoctl ipam show --ip=<IP> [--config=<CONFIG>]

Options:
  -h --help             Show this screen.
     --ip=<IP>          IP address to show.
-c --config=<CONFIG>    Path to the file containing connection
                        configuration in YAML or JSON format.
                        [default: /etc/calico/calicoctl.cfg]

Description:
  The ipam show command prints information about a given IP address, such as
  special attributes defined for the IP or whether the IP has been reserved by
  a user of the Calico IP Address Manager.

Examples

  1. Print the information associated with an IP address.

    calicoctl ipam show --ip=192.168.1.2
    

    The following results indicate that the IP is not assigned to an endpoint.

    Results
    IP 192.168.1.2 is not currently assigned
    
  2. Print the information associated with a different IP address.

    calicoctl ipam show --ip=192.168.1.1
    

    Results show that a basic Docker container has the assigned IP.

    No attributes defined for 192.168.1.1
    

Options

--ip=<IP>          IP address to show.

General options

-c --config=<CONFIG>       Path to the file containing connection
                           configuration in YAML or JSON format.
                           [default: /etc/calico/calicoctl.cfg]

See also