8. Command line reference

The vipu command line has the following syntax:

vipu [GlobalOptions] command ResourceType arguments [LocalOptions]

8.1. Resource types

As a user, you have access to a set of resource types to run commands against. These serve as the base objects in the V-IPU world.

Resource type

Description

agent

An agent runs on an IPU host device and helps set up IPUs for the Poplar application execution. Typically, an agent represents four IPUs.

allocation

An allocation is a logical representation of one or more agents bundled together. Users assigned to an allocation have access to the underlying IPUs managed by the agents tied to that particular allocation.

ipu

An IPU managed by an agent.

partition

A partition is a group of IPUs from an allocation assigned to do computational work (such as TensorFlow or Poplar applications) and configured such that the IPUs are able to communicate with one another. IPUs within a partition are “occupied” until the partition is deleted.

8.2. Global options

Global options work with all vipu commands. You can also pass global options as environment variables or in a configuration file.

Table 8.1 Global options

Option

Description

--api-access-key string

API access key

--api-host string --H string

Controller hostname or IP address

--api-port int --P int

Controller port number (default 8090)

--api-user-id string

user id (default $USER)

--config string

Choose a configuration file explicitly; do not look in the default locations

--help -h

Help with syntax and options

--quiet -q

Set quiet mode for the utility

--secure

Connect to the V-IPU controller in secure mode

--server-socket string --S string

Choose the local Unix socket to connect to the V-IPU controller. If this option is used the –api-host option is ignored

--server-version

Show version of the remote server

--showjson

Select JSON output

--timeout int

Set the time-out for client calls in seconds (default 1600)

--tls-cert-dir string

Directory for the TLS certificates (default ./vipu-certs)

--version -v

Show version

8.2.1. Using a configuration file

All the global options listed in Table 8.1 can be overridden with a V-IPU configuration file. The option names in the configuration file are identical but without the leading hyphens. For example, if you run vipu with the following command from the shell:

$ vipu --api-host my-host --api-port 8100 list partition

The corresponding options can be overridden in a configuration file that looks like this:

// vipu utility will try to connect to the API endpoint at myhost:8100
api-host = "my-host"
api-port = "8100"

The command line utility (vipu) will look for a V-IPU configuration file in the following directories, in this order, and will load the first file found:

  1. Configuration file provided with the --config option

  2. ./.vipu-cli.hcl

  3. $HOME/.vipu-cli.hcl

  4. /etc/vipu/vipu-cli.hcl

If you include credentials in the configuration file, then make sure that only your account has access to it (for example, chmod 0600 .vipu.hcl).

8.2.2. Using environment variables

All the global options listed in Table 8.1 can be overridden using environment variables using the syntax: VIPU_CLI_OPTION_NAME.

Everything should be upper case without the leading hyphens. The remaining hyphens (-) should be replaced by underscores (_). For example, if you run vipu with the following command from the shell:

$ vipu --api-host my-host --api-port 8100 list allocation

The corresponding options can be overridden with the following environment variables:

$ export VIPU_CLI_API_HOST="my-host"
$ export VIPU_CLI_API_PORT="8100"

8.3. Create partition

Creates an instance of a partition in the V-IPU controller.

8.3.1. Syntax

vipu [GlobalOptions] create partition [PARTITION_NAME] [LocalOptions]

8.3.2. Examples

# Create a partition "prt-0" of 4 IPUs in the user's default allocation
$ vipu create partition prt-0 --size 4

# Create a partition in project1 allocation and specify output dir for configuration file
$ vipu create partition prt-0 --allocation project1 --size 4 -s /path/to/confdir

8.3.3. Options

Table 8.2 Partition creation options

Option

Description

--all

Show all possible partitions. Only supported with the ‘–options’ flag

--allocation string

Specify an allocation ID

--index int

Specify index of the partition from the list (default -1)

--ipulink-segments uint32

Specify number of IPU-Link Segments for the partition

--ipuof-config-attrs

Enable support for IPUoF with attributes (Poplar >= 1.0.143) (default true)

--ipuof-config-enable

Enable writing IPUoF config files (default true)

--ipuof-config-location string --s string

Directory to write IPUoF configuration files to (default $HOME/.ipuof.conf.d)

--ipuof-config-ports

Enable support for IPUoF with non-default ports (default true)

--max-partition-options uint32

Specify the number of partition options to be returned. Used in conjunction with ‘–options’. (default 10)

--max-wait-time uint32

Specify the maximum wait time for a partition operation completion in seconds (default 120)

--num-gcds uint32

Specify the number of GCDs in the partition (default 1)

--options

Get a list of possible partitions

--reconfigurable

Enables reconfiguration for fabric multi-IPU partitions

--relocatable

Enables relocatable flag for the partition. A relocatable partition can be relocated to a different set of IPUs by the V-IPU controller, if needed.

--routing string

Specify a routing type: “dnc”, “swnc”, “ringswnc”, “btnc” (default most suitable)

--size int

Desired size (number of IPUs) of the new partition (must be a power of 2)

--sync-type string

Sync type for the partition: - “pod-native-default” (default), - “c2-compatible” (default if –reconfigurable is set), - “pod-native-repgraph”

--total-num-replicas uint32

Specify the total number of replicas across all GCDs. (default: 1 replica per GCD)

--help -h

Help with syntax and options

8.4. Get info about a partition

Get information about an existing partition on the V-IPU controller.

8.4.1. Syntax

$ vipu [{GlobalOptions}] get partition PARTITION_NAME [{LocalOptions}]

8.4.2. Options

Option

Description

--gcd uint32

Only output information for the specified GCD

--ipuof-configs

Outputs only IPUoF configuration information. The IPUoF information for each GCD is output in JSON format (as used in IPUoF configuration files). For a multi-GCD partition, the output will only be valid JSON if the –gcd id option is also used.

--help -h

Help with syntax and options

8.4.3. Examples

# get information about the partition named prt-0
$ vipu get partition prt-0

-----------------------------------------------------------
 Partition                | prt-0
 Cluster                  | cl0
 Allocation               | alloc0
 Creation Date            | Mon, 23 May 2022 10:53:13 CEST
 Created By               | alice
 GW-Link Routing          | N/A
 IPU-Link Routing         | DNC
 Number of ILDs           | 1
 Number of IPUs           | 4
 Number of GCDs           | 1
 Reconfigurable           | false
 Relocatable              | true
 State                    | ACTIVE
 IPUoF Server Version     | latest
 Provisioning State       | IDLE
 Sync Type                | POD_NATIVE_DEFAULT
 Number of Replicas       | Replicas=1
 Last Error               | N/A
 Max Auto-Reset Retries   | 10
 Current Auto-Reset Count | 0
 Last Auto-Reset Time     | N/A
 IPUs                     | 0=:0 1=:0 2=:0 3=:0
-----------------------------------------------------------

8.5. List allocations

List existing allocations on the V-IPU controller.

8.5.1. Syntax

$ vipu [{GlobalOptions}] list allocation

8.5.2. Options

Option

Description

--help -h

Help with syntax and options

8.5.3. Examples

# list allocations alice has access to
$ vipu list allocations

--------------------------------------------
 Cluster | Allocation | Agents
--------------------------------------------
 cl0     | alloc0     | ag01 ag02 ag03 ag04
 cl1     | project1   | ag05 ag06 ag07 ag08
--------------------------------------------

# list allocations fernando has access to
$ vipu list allocations --api-user-id fernando

--------------------------------------------
 Cluster | Allocation | Agents
--------------------------------------------
 cl1     | project1   | ag05 ag06 ag07 ag08
 cl1     | project2   | ag09 ag10 ag11 ag12
--------------------------------------------

8.6. List IPU attributes

List attributes from IPUs on the agents.

8.6.1. Syntax

$ vipu [{GlobalOptions}] list ipu-attrs

8.6.2. Options

Option

Description

--help -h

Help with syntax and options

8.6.3. Examples

# list the attributes of all IPUs that alice have access to
$ vipu list ipu-attrs

 Agent       | IPU | Attribute                 | Value
-----------------------------------------------------------
 ag01        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 | prt-0
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 | prt-0
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 | prt-0
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 | prt-0
             |     | physical slot             | 0
 ag02        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag03        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag04        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag05        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag06        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag07        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag08        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
-----------------------------------------------------------

# list the attributes of all IPUs that fernando have access to
$ vipu list ipu-attrs

 Agent       | IPU | Attribute                 | Value
-----------------------------------------------------------
 ag05        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag06        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag07        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag08        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag09        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag10        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag11        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag12        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
-----------------------------------------------------------

# list the attributes of all IPUs that bob have access to
$ vipu list ipu-attrs

 Agent       | IPU | Attribute                 | Value
-----------------------------------------------------------
 ag09        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag10        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag11        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
 ag12        | 0   | clock                     | 1330MHz
             |     | dnc_id                    | 0
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 1   | clock                     | 1330MHz
             |     | dnc_id                    | 1
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 2   | clock                     | 1330MHz
             |     | dnc_id                    | 2
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
             | 3   | clock                     | 1330MHz
             |     | dnc_id                    | 3
             |     | driver version            | 1.0.56
             |     | firmware patch version    | 4
             |     | hexopt total size (bytes) | 268435456
             |     | ipu error state           | no errors
             |     | numa node                 | 0
             |     | partition                 |
             |     | physical slot             | 0
-----------------------------------------------------------

8.7. List partitions on a cluster

List configured partitions on the V-IPU controller.

8.7.1. Syntax

$ vipu [{GlobalOptions}] list partition [{LocalOptions}]

8.7.2. Options

Option

Description

--allocation string

Specify an allocation ID

--help -h

Help with syntax and options

8.7.3. Examples

# list all partitions that alice have access to
$ vipu list partitions

 Cluster     | Allocation | Partition | ILDs | IPU-Gateway Routing | ILD Routing | Size | GCDs | State
--------------------------------------------------------------------------------------------------------
 cl0         | alloc0     | prt-0     | 1    | N/A                 | DNC         | 4    | 1    | ACTIVE
 cl0         | alloc0     | prt-1     | 1    | N/A                 | DNC         | 2    | 1    | ACTIVE
 cl0         | alloc0     | prt-2     | 1    | N/A                 | DNC         | 2    | 1    | ACTIVE
 cl0         | alloc0     | prt-3     | 1    | N/A                 | DNC         | 4    | 1    | ACTIVE
--------------------------------------------------------------------------------------------------------

8.8. Remove a partition

Remove a configured partition from the V-IPU controller.

8.8.1. Syntax

$ vipu [{GlobalOptions}] remove partition PARTITION_NAME [{LocalOptions}]

8.8.2. Options

Option

Description

--force -f

Force the removal of the partition ignoring errors

--ipuof-config-location string --s string

Directory to check for removing IPUoF config files

--max-wait-time uint32

Specify the maximum wait time for a partition operation completion in seconds (default 120)

--help -h

Help with syntax and options

8.8.3. Examples

# remove partition prt-3
$ vipu remove partition prt-3

Please be patient. This operation can take several seconds
..
remove partition (prt-3): success.

# remove partition prt-1 and prt-2
$ vipu remove partition prt-1 prt-2

Please be patient. This operation can take several seconds
..
remove partition (prt-1): success.
Please be patient. This operation can take several seconds
..
remove partition (prt-2): success.

8.9. Reset a partition

Reset a configured partition on the V-IPU controller.

8.9.1. Syntax

$ vipu [{GlobalOptions}] reset partition PARTITION_NAME [{LocalOptions}]

8.9.2. Options

Option

Description

--all

Reset all partitions

--max-wait-time uint32

Specify the maximum wait time for a partition operation completion in seconds (default 120)

--relocatable

Enable relocatable flag for the partition. Existing flag will be overridden.

--help -h

Help with syntax and options

8.9.3. Examples

# reset/recreate partition prt-0
$ vipu reset partition prt-0

Please be patient. This operation can take several seconds
...
reset partition (prt-0): success.

#
$ vipu reset partition prt-1

Please be patient. This operation can take several seconds
...
reset partition (prt-1): success.

# reset all partitions
$ vipu reset partition --all

Please be patient. This operation can take several seconds
...
reset partition (prt-0): success.
Please be patient. This operation can take several seconds
...
reset partition (prt-1): success.
Please be patient. This operation can take several seconds
...
reset partition (prt-2): success.
Please be patient. This operation can take several seconds
...
reset partition (prt-3): success.

8.10. Bash command completion script

To load the command completion script, run:

$ source <(vipu bash-completion)

To configure your Bash shell to load completions for each session, run:

$ vipu bash-completion > /etc/bash_completion.d/vipu

8.10.1. Syntax

$ vipu [{GlobalOptions}] bash-completion

8.10.2. Options

Option

Description

--help -h

Help with syntax and options

8.11. Zsh command completion script

If shell completion is not already enabled in your environment, you will need to enable it. You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

To load the command completion script, run:

$ source <(vipu zsh-completion)

To configure your Zsh shell to load completions for each session, run:

$ vipu zsh-completion > "${fpath[1]}/_vipu"

You will need to start a new shell for this setup to take effect.

8.11.1. Syntax

$ vipu [{GlobalOptions}] zsh-completion

8.11.2. Options

Option

Description

--help -h

Help with syntax and options