8. Admin command line reference

The vipu-admin command line utility has the following syntax:

vipu-admin [GlobalOptions] Command ResourceType Arguments [LocalOptions]

  • Command: Specifies the operation that are to be executed on one or more resources. The commands supported are listed in Table 8.1.

  • ResourceType: Specifies the resource type on which the given command is to be executed. The resource types are described in Table 8.2. The commands supported for each resource type are listed in Table 8.3. Note that not all resource types are supported for all commands.

  • Options: Specify options on the command line to provide additional information globally or for specific commands. The global options are listed in Table 8.4. The local options are shown in the description for each command.

  • Arguments: Specify resource names or other information supplied to the command line. For example, the name of the agent (“myagent”) in the command below:

    $ vipu-admin create agent myagent --host myhost --port 8080
    
Table 8.1 Command summary

Command

Description

bash-completion

create

Create entities

discover

Discover entities

get

Get info about an entity

list

List entities

remove

Remove entities

rename

Rename entities

reset

Reset entities

test

Test entities

zsh-completion

Table 8.2 Resource types

Resource

Description

agent

A V-IPU agent running on an IPU-Machine (see Section 6.2.1, Agent entity).

user

A user of the V-IPU software (see Section 5.1, Users).

cluster

A V-IPU cluster. The IPUs in a single cluster are capable of directly communicating and synchronising (see Section 6.2.2, Clusters).

ipu

Represents a single IPU in an IPU-Machine.

allocation

An allocation represents a set of IPUs bundled together (see Section 5.2, Allocations).

partition

A partition defines a set of IPUs within a cluster that provides an isolated domain for running user applications (see Section 6.2.4, Partition).

Table 8.3 Commands for each resource type

Resource type

Description

Agent

Allocation

Cluster

IPU

Partition

User

8.1. Global options

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

Table 8.4 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 admin)

--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.1.1. Using a configuration file

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

$ vipu-admin --api-host my-host --api-port 8100 list agents

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

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

The command line utilities (vipu-admin and vipu) will look for a configuration file in the following ordered list of directories and will load the first configuration 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

8.1.2. Using environment variables

All the options listed in Section 8.1, Global options 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-admin with the following command from the shell:

$ vipu-admin --api-host my-host --api-port 8100 list agents

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

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

8.2. Script generation

8.2.1. Bash command completion script

To load the command completion script, run:

$ source <(vipu-admin bash-completion)

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

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

Syntax

$ vipu-admin [{GlobalOptions}] bash-completion

Options

Option

Description

--help -h

Help with syntax and options

8.2.2. 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-admin zsh-completion)

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

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

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

Syntax

$ vipu-admin [{GlobalOptions}] zsh-completion

Options

Option

Description

--help -h

Help with syntax and options

8.3. Create entities

Create entities in a V-IPU controller.

8.3.1. Create an agent

Create an agent on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] create agent AGENT_NAME [{LocalOptions}]

Options

Option

Description

--exporter-metrics-path string

Provide the metrics path for the virm-exporter associated with this agent (default /metrics))

--exporter-port uint16

Provide the port for the virm-exporter associated with this agent (default 2112)

--force -f

Creates agent without validating connection and agent platform

--host string

Provide the host for the agent

--port uint16

Provide the port for the agent (default 8080)

--help -h

Help with syntax and options

Examples

# add agent ag01 in the V-IPU controller
$ vipu-admin create agent ag01 --host 10.1.2.10 --port 8080

create agent (ag01): success.

8.3.2. Create an allocation

Create an allocation of the IPUs on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] create allocation ALLOCATION_NAME [{LocalOptions}]

Options

Option

Description

--cluster string

Specify a cluster ID

--index int

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

--max-allocation-options uint32

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

--options

Get a list of possible allocations

--size int

Desired size of the new allocation (default -1)

--help -h

Help with syntax and options

Examples

# list all allocations of 16 IPUs that can be created in the cluster cl1
$ vipu-admin create allocation --options --cluster cl1 --size 16

 Index       | Cluster | Size | Agents
---------------------------------------
 0           | cl1     | 16   | ag05
             |         |      | ag06
             |         |      | ag07
             |         |      | ag08
 1           | cl1     | 16   | ag09
             |         |      | ag10
             |         |      | ag11
             |         |      | ag12
---------------------------------------

# list all allocations of 16 IPUs that can be created in any clusters
$ vipu-admin create allocation --options --size 16

 Index       | Cluster | Size | Agents
---------------------------------------
 0           | cl0     | 16   | ag01
             |         |      | ag02
             |         |      | ag03
             |         |      | ag04
 1           | cl1     | 16   | ag05
             |         |      | ag06
             |         |      | ag07
             |         |      | ag08
 2           | cl1     | 16   | ag09
             |         |      | ag10
             |         |      | ag11
             |         |      | ag12
---------------------------------------

# create an allocation using a list of agents
$ vipu-admin create allocation project1 --agents=ag01,ag02,ag03,ag04

create allocation (project1): success.

# create an allocation of 16 IPUs in the cluster named cl1
$ vipu-admin create allocation project2 --cluster cl1 --size 16

create allocation (project2): success.

8.3.3. Create a cluster

Create a cluster on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] create cluster CLUSTER_NAME [{LocalOptions}]

Options

Option

Description

--agents stringSlice

Specify a comma separated list of agents

--cluster-topology string

Specify the GW-Link topology (default looped))

--create-default-allocation

Create a default allocation upon successful creation of the cluster (default true)

--num-ipulinkdomains int

Specify number of IPU-Link domains when creating cluster by agents (default 1)

--topology string --t string

Specify the IPU-Link topology (default mesh))

--help -h

Help with syntax and options

Examples

# create a cluster
$ vipu-admin create cluster cl1 --agents ag05,ag06,ag07,ag08,ag09,ag10,ag11,ag12 --num-ipulinkdomains 1 --topology mesh --cluster-topology looped --create-default-allocation=false

create cluster (cl1): success.

Warning

For backward compatibility with older V-IPU installations, a default allocation with the same name as the cluster will be created unless --create-default-allocation=false. This default allocation ensures that users and administrators can create partitions without the need to create allocations explicitly. With V-IPU 1.18, this behaviour will change and allocation will have to be created explicitly.

8.3.4. Create a partition

$ ./vipu-admin create partition [PARTITION_NAME] [options]

Create a partition in the V-IPU controller. Users can create partitions from the allocations that are assigned to them (see Section 5.2, Allocations) or an administrator can create partitions for use by users.

IPUoF configuration file

In order to communicate with the Pod, Poplar needs a configuration file with details of how to connect to the IPU-Machines. This file is created when you create a partition. The default location is the directory $HOME/.ipuof.conf.d/. You can change the directory using the --ipuof-config-location option (see Section 8.3.4, Create a partition).

There must only be one configuration file in this directory. If Poplar finds more than one file, then it will throw an exception.

By default, the automatically-created file is named partition-name.conf but Poplar will read any file that it finds in that location.

If you, as an administrator, create partitions for users, then you might want to put a symbolic link to the configuration file in their $HOME/.ipuof.conf.d directory. By making sure that the user has only read access to the file and the symbolic link you can securely manage access to the IPU resources.

The file contains information about:

  • The number of IPUs assigned to this user

  • Networking details for how to connect to those IPUs

For example:

{
  "devices": [
    {
      "ip": "10.1.5.1",
      "server_port": 50052,
      "rdma_port": 7471,
      "device_id": 3,
      "ipulink_segment_id": 0,
      "routing_id": 0,
      "ipu_arch_id": 2,
      "ipu_id": 2
    }
  ],
  "attributes": {
    "IPU version": "ipu2",
    "Routing Type": "DNC"
  }
}

There is a single device (which may correspond to one or more IPUs) in the “devices” array that can be accessed from the specified IP address (10.1.5.1 in this example). The rest is additional information used by IPUoF to connect to the server-side IPUoF component (see Section 3.1, V-IPU agents).

Supported 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.3.5. Create a user

Create a user on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] create user USER_NAME [{LocalOptions}]

Options

Option

Description

--adminuser

Specify that the new user is an admin user

--allocations stringSlice

Specify a comma separated list of allocations the user has access to

--default-allocation string

Specify the default allocation the user has access to. The default allocation must be in the list of allocations the user has access to.

--dont-write-user-config-file

Specify whether the user vipu config file will be written

--user-config-file string

Specify file to write the user configuration to (default is {USERID}.vipu-cli.hcl)

--help -h

Help with syntax and options

Examples

# create the user named alice
$ vipu-admin create user alice --dont-write-user-config-file

create user (alice): success. Access key is "[redacted]".
Please note that the user alice will not be able to use IPUs until an allocation is associated with user alice

# create the user named bob, with administrative privileges
$ vipu-admin create user bob --adminuser --dont-write-user-config-file

create user (bob): success. Access key is "[redacted]".
Please note that the user bob will not be able to use IPUs until an allocation is associated with user bob

# create the user named fernando and add it to the allocations: project1 and project2
$ vipu-admin create user fernando --dont-write-user-config-file --allocations project1,project2

create user (fernando): success. Access key is "[redacted]".
project1 has been set as the default allocation for user fernando

8.4. Discover entities

Discover entities from the V-IPU controller.

8.4.1. Discover agents

Syntax

$ vipu-admin [{GlobalOptions}] discover agent [{LocalOptions}]

Options

Option

Description

--auto-add -a

Automatically add all agents that have been seen in the last 30 seconds

--help -h

Help with syntax and options

Examples

# discover all agents
$ vipu-admin discover agents

 Host        | Port  | Network Interface | Time Since Last Seen | Agent Auto-Add ID
------------------------------------------------------------------------------------
 10.1.2.10   | 8080  | lo                | 2.7s                 | 10.1.2.10-8080
 10.1.2.11   | 8080  | lo                | 2.7s                 | 10.1.2.11-8080
 10.1.2.12   | 8080  | lo                | 2.7s                 | 10.1.2.12-8080
 10.1.2.13   | 8080  | lo                | 2.7s                 | 10.1.2.13-8080
 10.1.2.14   | 8080  | lo                | 2.7s                 | 10.1.2.14-8080
 10.1.2.15   | 8080  | lo                | 2.7s                 | 10.1.2.15-8080
 10.1.2.16   | 8080  | lo                | 2.7s                 | 10.1.2.16-8080
 10.1.2.17   | 8080  | lo                | 2.7s                 | 10.1.2.17-8080
 10.1.2.18   | 8080  | lo                | 2.7s                 | 10.1.2.18-8080
 10.1.2.19   | 8080  | lo                | 2.7s                 | 10.1.2.19-8080
 10.1.2.20   | 8080  | lo                | 2.7s                 | 10.1.2.20-8080
 10.1.2.21   | 8080  | lo                | 2.7s                 | 10.1.2.21-8080
------------------------------------------------------------------------------------

8.5. List entities

List entities from the V-IPU controller.

8.5.1. List connected agents

List connected agents on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] list agent

Options

Option

Description

--help -h

Help with syntax and options

Examples

# list all agents
$ vipu-admin list agents

 Agent       | Host      | Port  | Status | Agent Version | IPUs | System Uptime | Agent Uptime | Last Error | Warnings
------------------------------------------------------------------------------------------------------------------------
 ag01        | 10.1.2.10 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag02        | 10.1.2.11 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag03        | 10.1.2.12 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag04        | 10.1.2.13 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag05        | 10.1.2.14 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag06        | 10.1.2.15 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag07        | 10.1.2.16 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag08        | 10.1.2.17 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag09        | 10.1.2.18 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag10        | 10.1.2.19 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag11        | 10.1.2.20 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
 ag12        | 10.1.2.21 | 8080  | Up     | 1.8.0         | 4/4  | 8h 54m 2.7s   | 5h 57m 2.7s  |            |
------------------------------------------------------------------------------------------------------------------------

8.5.2. List allocations

List existing allocations on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] list allocation

Options

Option

Description

--help -h

Help with syntax and options

Examples

# list all allocations
$ vipu-admin list allocations

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

8.5.3. List available clusters

List available clusters on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] list cluster

Options

Option

Description

--help -h

Help with syntax and options

Examples

# list all clusters
$ vipu-admin list clusters

 Cluster     | GW-Link Topology | ILDs | ILD Topology | IPUs
-------------------------------------------------------------
 cl0         | N/A              | 1    | MESH         | 16
 cl1         | N/A              | 1    | MESH         | 32
-------------------------------------------------------------

8.5.4. List IPUs

List IPUs available in the allocations.

Syntax

$ vipu-admin [{GlobalOptions}] list ipu

Options

Option

Description

--help -h

Help with syntax and options

Examples

# list all IPUs
$ vipu-admin list ipu

 Agent       | IPU | PCI          | Device | Firmware | Architecture | IPUIdAttr
---------------------------------------------------------------------------------
 ag01        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag02        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag03        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag04        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag05        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag06        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag07        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag08        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag09        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag10        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag11        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
 ag12        | 0   | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 2
             | 1   | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 2
             | 2   | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 2
             | 3   | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 2
---------------------------------------------------------------------------------

8.5.5. List IPU attributes

List attributes from IPUs on the agents.

Syntax

$ vipu-admin [{GlobalOptions}] list ipu-attrs

Options

Option

Description

--help -h

Help with syntax and options

Examples

# list the attributes of all IPUs
$ vipu-admin 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                 |
             |     | 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
 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
 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.5.6. List partitions on a cluster

List configured partitions on the V-IPU controller.

Syntax

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

Options

Option

Description

--allocation string

Specify an allocation ID

--help -h

Help with syntax and options

Examples

# list all partitions
$ vipu-admin list partitions

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

8.5.7. List users

List existing users on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] list user

Options

Option

Description

--help -h

Help with syntax and options

Examples

# list all users
$ vipu-admin list users

 User        | Allocations
---------------------------------
 admin       |
 alice       | project1
 bob         | project2
 fernando    | project1 project2
---------------------------------

8.6. Get info about an entity

Get information about an entity from the V-IPU controller.

8.6.1. Get info about an agent

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

Syntax

$ vipu-admin [{GlobalOptions}] get agent AGENT_NAME [{LocalOptions}]

Options

Option

Description

--ipu-attributes

Show all IPU attributes

--help -h

Help with syntax and options

Examples

# get information about the agent named ag01
$ vipu-admin get agent ag01

-------------------------------------------------------------------------
 Agent                        | ag01
 Host                         | 10.1.2.10
 Port                         | 8080
 Status                       | Up
 Exporter                     | http://10.1.2.11:2112/metrics
 Creation Date                | Mon, 23 May 2022 10:53:13 CEST
 Created By                   | admin
 Platform                     | ipum-p2
 Manufacturer                 | Graphcore
 Discovery Mode               | DM_GCDA
 V-IPU Agent Version          | 1.8.0
 IPU-M SW Version             | 2.5.0
 Runtime Version              | 1.1.2
 Board Serial Number          | 8203921-0007
 Part Number                  | GC-ADA2-00-ES1 Rev. C
 Linux Kernel Version         | 4.19.206-8e61e61e3-ipum
 Power Profile                | default
 IPU-Gateway Software Version | 2.4.0-8
 IPUoF Server Version         | v1.9.0
 HDF Version                  | 1.3.0
 HDF Hash                     | d21c7a00ba20fa07d0b688fa9de7941cae250fcc
 IPU Driver Version           | 1.0.58
 Number of IPUs               | 4
----------------------------------------------------------------------------------------------------------------------------------
 IPU         | PCI          | Device | Firmware | Architecture | Num Tiles | Silicon ID                 | IPU Health | Last Error
----------------------------------------------------------------------------------------------------------------------------------
 0           | 0000:60:00.0 | 0      | 2.4.4    | 2 (ipu2)     | 1472      | T8N534.4.1.6.T8N53400.9920 | OK         |
 1           | 0000:61:00.0 | 1      | 2.4.4    | 2 (ipu2)     | 1472      | T8N534.4.1.6.T8N53400.9921 | OK         |
 2           | 0000:62:00.0 | 2      | 2.4.4    | 2 (ipu2)     | 1472      | T8N534.4.1.6.T8N53400.9922 | OK         |
 3           | 0000:63:00.0 | 3      | 2.4.4    | 2 (ipu2)     | 1472      | T8N534.4.1.6.T8N53400.9923 | OK         |

8.6.2. Get info about an allocation

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

Syntax

$ vipu-admin [{GlobalOptions}] get allocation ALLOCATION_NAME

Options

Option

Description

--help -h

Help with syntax and options

Examples

# get information about the allocation named project1
$ vipu-admin get allocation project1

------------------------------------------------
 Cluster       | cl1
 Allocation    | project1
 Creation Date | Mon, 23 May 2022 10:53:13 CEST
 Created By    | vipu-admin
 Agents        | ag05 ag06 ag07 ag08
------------------------------------------------

8.6.3. Get info about a cluster

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

Syntax

$ vipu-admin [{GlobalOptions}] get cluster CLUSTER_NAME

Options

Option

Description

--help -h

Help with syntax and options

Examples

# get information about the cluster named cl0
$ vipu-admin get cluster cl0

-------------------------------------------------------------
 Cluster           | cl0
 Creation Date     | Mon, 23 May 2022 10:53:13 CEST
 Created By        | vipu-admin
 GW-Link Topology  | N/A
 Number of ILDs    | 1
 IPU-Link Topology | MESH
 Number of IPUs    | 16
 IPUs              | IPU-Link Domain 0
                   | 0=ag01:0 1=ag01:1 2=ag01:2 3=ag01:3
                   | 4=ag02:0 5=ag02:1 6=ag02:2 7=ag02:3
                   | 8=ag03:0 9=ag03:1 10=ag03:2 11=ag03:3
                   | 12=ag04:0 13=ag04:1 14=ag04:2 15=ag04:3
-------------------------------------------------------------

# get information about a renamed cluster
$ vipu-admin get cluster cl3

---------------------------------------------------------------
 Cluster             | cl3
 Creation Date       | Mon, 23 May 2022 10:53:13 CEST
 Created By          | vipu-admin
 Last Updated        | Mon, 23 May 2022 10:53:13 CEST
 Last Updated Reason | renamed cl1 to cl3
 GW-Link Topology    | N/A
 Number of ILDs      | 1
 IPU-Link Topology   | MESH
 Number of IPUs      | 32
 IPUs                | IPU-Link Domain 0
                     | 0=ag05:0 1=ag05:1 2=ag05:2 3=ag05:3
                     | 4=ag06:0 5=ag06:1 6=ag06:2 7=ag06:3
                     | 8=ag07:0 9=ag07:1 10=ag07:2 11=ag07:3
                     | 12=ag08:0 13=ag08:1 14=ag08:2 15=ag08:3
                     | 16=ag09:0 17=ag09:1 18=ag09:2 19=ag09:3
                     | 20=ag10:0 21=ag10:1 22=ag10:2 23=ag10:3
                     | 24=ag11:0 25=ag11:1 26=ag11:2 27=ag11:3
                     | 28=ag12:0 29=ag12:1 30=ag12:2 31=ag12:3
---------------------------------------------------------------

8.6.4. Get info about a partition

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

Syntax

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

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

Examples

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

----------------------------------------------------------------
 Partition                | prt-0
 Cluster                  | cl1
 Allocation               | project1
 Creation Date            | Mon, 23 May 2022 10:53:13 CEST
 Created By               | vipu-admin
 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=ag05:0 1=ag05:1 2=ag05:2 3=ag05:3
----------------------------------------------------------------

8.6.5. Get info about a user

Get information about a user on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] get user USER_NAME

Options

Option

Description

--help -h

Help with syntax and options

Examples

# get information about the user named fernando
$ vipu-admin get user fernando

--------------------------------------------------------
 User ID               | fernando
 Creation Date         | Mon, 23 May 2022 10:53:13 CEST
 Created By            | vipu-admin
 Default Allocation ID | project1
 User Role             | User
 Permitted Allocations | project1 project2
--------------------------------------------------------

8.7. Remove entities

Remove entities from V-IPU controller.

8.7.1. Remove an agent

Remove an agent from the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] remove agent AGENT_NAME

Options

Option

Description

--help -h

Help with syntax and options

Examples

# remove agent ag01 from the V-IPU controller
$ vipu-admin remove agent ag01

remove agent (ag01): success.

8.7.2. Remove an allocation

Remove an allocation from the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] remove allocation ALLOCATION_NAME

Options

Option

Description

--help -h

Help with syntax and options

Examples

# remove the allocation named project1
$ vipu-admin remove allocation project1

remove allocation (project1): success.

# remove the allocation named project2
$ vipu-admin remove allocation project2

remove allocation (project2): success.

8.7.3. Remove a cluster

Remove a cluster from the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] remove cluster CLUSTER_NAME

Options

Option

Description

--help -h

Help with syntax and options

Examples

# remove cluster named cl1
$ vipu-admin remove cluster cl1

remove cluster (cl1): success.

8.7.4. Remove a partition

Remove a configured partition from the V-IPU controller.

Syntax

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

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

Examples

# remove partition prt-3
$ vipu-admin 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-admin 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.7.5. Remove a user

Remove an existing user from the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] remove user USER_NAME

Options

Option

Description

--help -h

Help with syntax and options

Examples

# remove the user named fernando
$ vipu-admin remove user fernando

remove user (fernando): success.

8.8. Rename entities

Rename entities.

8.8.1. Rename an available agent

Rename an available agent on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] rename agent OLD_AGENT NEW_AGENT

Options

Option

Description

--help -h

Help with syntax and options

Examples

# rename agent ag01 to ag1
$ vipu-admin rename agent ag01 ag1

rename agent (ag01  --> renamed to --> ag1): success.

Note

The renamed agent must exist and not be part of any partition nor allocation.

8.8.2. Rename an available cluster

Rename an available cluster on the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] rename cluster OLD_CLUSTER NEW_CLUSTER

Options

Option

Description

--help -h

Help with syntax and options

Examples

# rename cluster named cl2 to cl3
$ vipu-admin rename cluster cl1 cl3

rename cluster (cl1 --> renamed to --> cl3): success.

Note

The renamed cluster must exist and not contain any partition nor allocation.

8.9. Reset entities

Reset entities on V-IPU controller.

8.9.1. Reset a partition

Reset a configured partition on the V-IPU controller.

Syntax

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

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

Examples

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

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

#
$ vipu-admin reset partition prt-1

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

# reset all partitions
$ vipu-admin 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. Test entities

Test entities from V-IPU controller. See Section 6.4, Cluster tests for more details of the tests performed.

8.10.1. Test a cluster

Run tests on a cluster configured at the V-IPU controller.

Syntax

$ vipu-admin [{GlobalOptions}] test cluster CLUSTER_NAME [{LocalOptions}]

Options

Option

Description

--cabling

Check whether cabling is correct for the topology

--gwlink

Run GW-Link test

--gwtraffic

Run IPU-Gateway (GW) traffic test

--ipulink

Run IPU-Link test

--pfc-settings

Check whether agent RNIC PFC settings is as expected

--start

Dispatch an asynchronous cluster test request to the server

--status

Dispatch an asynchronous cluster test request to the server

--stop

Dispatch an asynchronous cluster test request to the server

--sync

Run Sync-Link test

--traffic

Run traffic test

--versions

Run a version consistency test and report if the hardware and software installed on all IPU-Machines have compatible versions

--help -h

Help with syntax and options

Examples

# run all tests on the cluster named cl0
$ vipu-admin test cluster cl0

Showing test results for cluster cl0
 Test Type   | Duration | Passed | Summary
-------------------------------------------------------------------------
 Cabling     | 2.7s     | 12/12  | All cables connected as expected
 GW-Link     | 2.7s     | 0/0    | GW-Link test skipped
 Sync-Link   | 2.7s     | 0/0    | Sync Link test skipped
 IPU-Link    | 2.7s     | 76/76  | IPU-Links test passed
 Traffic     | 2.7s     | 1/1    | Traffic test passed
 Version     | 2.7s     | 8/8    | All component versions are consistent
 GW Traffic  | 2.7s     | 0/0    | GW Traffic test skipped
-------------------------------------------------------------------------

# test IPU-Links on the cluster named cl1
$ vipu-admin test cluster cl1 --ipulink

Showing test results for cluster cl1
 Test Type   | Duration | Passed  | Summary
----------------------------------------------------------
 IPU-Link    | 2.7s     | 156/156 | IPU-Links test passed
----------------------------------------------------------