calicoctl ipam

3 MINUTE READ

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> | --show-blocks] [--config=<CONFIG>]

Options:
  -h --help                Show this screen.
     --ip=<IP>             Report whether this specific IP address is in use.
     --show-blocks         Show detailed information for IP blocks as well as pools.
     --show-borrowed       Show detailed information for "borrowed" IP addresses.
     --show-configuration  Show current Calico IPAM configuration.
  -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, or about
  overall IP usage.

Examples

  1. Print the information associated with an IP address.

    calicoctl ipam show --ip=192.168.1.2
    

    The following result indicates that the IP is not assigned to an endpoint.

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

    calicoctl ipam show --ip=10.244.118.70
    

    For a Kubernetes pod IP, attributes indicate the pod name and namespace:

    IP 10.244.118.70 is in use
    Attributes:
      pod: nano-66d4c99f8b-jm5s9
      namespace: default
      node: ip-172-16-101-160.us-west-2.compute.internal
    
  3. Print a summary of IP usage.

    calicoctl ipam show
    

    The table shows usage for each IP Pool:

    +----------+-------------------+------------+------------+-------------------+
    | GROUPING |       CIDR        | IPS TOTAL  | IPS IN USE |     IPS FREE      |
    +----------+-------------------+------------+------------+-------------------+
    | IP Pool  | 10.65.0.0/16      |      65536 | 5 (0%)     | 65531 (100%)      |
    | IP Pool  | fd5f:abcd:64::/48 | 1.2089e+24 | 7 (0%)     | 1.2089e+24 (100%) |
    +----------+-------------------+------------+------------+-------------------+
    
  4. Print more detailed IP usage by blocks.

    calicoctl ipam show --show-blocks
    

    As well as the total usage per IP Pool, the table shows usage for block that has been allocated from those pools:

    +----------+-------------------------------------------+------------+------------+-------------------+
    | GROUPING |                   CIDR                    | IPS TOTAL  | IPS IN USE |     IPS FREE      |
    +----------+-------------------------------------------+------------+------------+-------------------+
    | IP Pool  | 10.65.0.0/16                              |      65536 | 5 (0%)     | 65531 (100%)      |
    | Block    | 10.65.79.0/26                             |         64 | 5 (8%)     | 59 (92%)          |
    | IP Pool  | fd5f:abcd:64::/48                         | 1.2089e+24 | 7 (0%)     | 1.2089e+24 (100%) |
    | Block    | fd5f:abcd:64:4f2c:ec1b:27b9:1989:77c0/122 |         64 | 7 (11%)    | 57 (89%)          |
    +----------+-------------------------------------------+------------+------------+-------------------+
    
  5. Print more detailed information about borrowed IP addresses.

    calicoctl ipam show --show-borrowed
    

    Table shows which IP addresses have been borrowed by which node out of which block and the entity consuming it:

    +------------+-----------------+---------------+---------------+------+------------------------------------+
    |     IP     | BORROWING-NODE  |     BLOCK     |  BLOCK OWNER  | TYPE |            ALLOCATED-TO            |
    +------------+-----------------+---------------+---------------+------+------------------------------------+
    | 172.16.0.1 | worker-node-1   | 172.16.0.0/29 | worker-node-2 | pod  | external-ns/nginx-6db489d4b7-gln7h |
    | 172.16.0.2 | worker-node-3   | 172.16.0.0/29 | worker-node-2 | pod  | external-ns/nginx-6db489d4b7-kzkbv |
    +------------+-----------------+---------------+---------------+------+------------------------------------+
    
  6. Print current IPAM configuration.

    calicoctl ipam show --show-configuration
    

    Table shows current IPAM configuration:

    +--------------------+-------+
    |      PROPERTY      | VALUE |
    +--------------------+-------+
    | StrictAffinity     | false |
    | AutoAllocateBlocks | true  |
    +--------------------+-------+
    

Options

--ip=<IP>             Specific IP address to show.
--show-blocks         Show detailed information for IP blocks as well as pools.
--show-borrowed       Show detailed information for "borrowed" IP addresses.
--show-configuration  Show current Calico IPAM configuration

General options

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

See also