tpvm

Resource URIs

URI Description
<base_URI>/config/running/tpvm Configure TPVM parameters.
PUT URIs Payload Description
<base_URI>/config/running/tpvm/TPVM/interface/management/ipv6 <ipv6><dhcpv6>true</dhcpv6></ipv6> Configures enabling DHCP for assigning IPv6 address for the management interface (eth0) of the TPVM.
<base_URI>/config/running/tpvm/TPVM/interface/management/ipv6 <ipv6-params><ipv6addr> <ipv6-address-and-mask></ipv6addr><gw><gw-ipv6-address> </gw></ipv6-params> Configures the IPv6 address and gateway for the management interface (eth0) of the TPVM.
<base_URI>/config/running/tpvm/TPVM/dns <dns> <dns-params> <primary-server><ipv6-address> </primary-server><secondary-server><ipv6-address> </secondary-server> <domain>domain-name</domain> </dns-params> </dns> Configures the primary and secondary DNS servers for the management interface (eth0) of the TPVM. Also configures the domain name.
<base_URI>/config/running/tpvm/TPVM/ntp <ntp> <server><host-name></server> <server><ipv4-address></server> <server><ipv6-address></server> Configures the NTP servers for use with this TPVM instance. Up to 5 NTP servers can be configured. NTP servers can be configured as IPv4 or IPv6 address formats or as FQDNs.
<base_URI>/config/running/tpvm/TPVM/trusted-peer <trusted-peer> <pwless> <ipv6><ipv6-address></ipv6> <password><password></password></pwless> <sudo-user><sudo-user-account></sudo-user> </trusted-peer> Configures the trusted peer and sets its access credentials.
<base_URI>/config/running/tpvm/TPVM/ldap/ca-cert/import <import> <protocol></protocol-to-use> <user><user-name></user> <ldap-password><password></ldap-password> <ldap-host><hostname:ip-address></ldap-host> <directory><remote-directory></directory> <filename><cert-file-name></filename> </import> Imports a particular certificate from a remote LDAP server.
<base_URI>/config/running/tpvm/TPVM/ldap/ldap-server/ldap-server-options <ldap-server> <host><hostname:ip-address></host> <port><port-number></port> </ldap-server> Configures a LDAP server using either its FQDN or using its IPv4 or IPv6 address.
PUT URIs Payload Description
<base_URI>/config/running/tpvm/upgrade <upgrade> <protocol><protocol-to-use></protocol> <user><user-name></user> <password><password></password> <host><host-ip-address></host> <directory><remote-directory></directory> <filename><image-file-name></filename> </upgrade> Configures the parameters to upgrade TPVM.
<base_URI>/config/running/tpvm/download <download> <protocol><protocol-to-use></protocol> <user><user-name></user> <password><password></password> <host><host-ip-address></host> <directory><remote-directory></directory> <filename><image-file-name></filename> Configures the parameters to download a TPVM image file.

Parameters

ipv6params
ipv6addr ipv6-address-and-mask
The IPv6 address and mask to be configured on the management interface (eth0) of the TPVM.
gw gw-ipv6-address
The IPv6 address of the default gateway.
dns
dns-params
primary-server ipv6-address
The IPv6 address of the primary DNS server.
secondary-server ipv6-address
The IPv6 address of the secondary DNS server.
domain domain-name
The domain of this instance of TPVM.
ntp
server host-name
The hostname of a NTP server.
server ipv4-address
The IPv4 address of a NTP server
server ipv6-address
The IPv6 address of a NTP server
trusted-peer
pwless
ipv6 ipv6-address
The IPv6 address of the trusted-peer.
password password
The password for the trusted-peer device.
sudo-user sudo-user-account
The account used to become the SUDO user on the trusted-peer device.
upgrade
protocol protocol-to-use
The protocol to use to access the remote download server.
user user-name
The account used to access the remote download server.
password password
The password for the account used to access the remote download server.
host host-ip-address
The IP address of the remote download server which contains the TPVM image.
directory remote-directory
The directory on the remote download server where the TPVM image is stored.
filename image-file-name
The filename of the TPVM image.
import
protocol protocol-to-use
The protocol to use to access the remote LDAP server.
user user-name
The account used to access the remote LDAP server.
ldap-password password
The password for the account used to access the remote LDAP server.
ldap-host hostname:ip-address
The FQDN hostname or IPv4/IPv6 address of the remote LDAP server which contains the certificate.
directory remote-directory
The directory on the remote LDAP server where the certificate is stored.
filename cert-file-name
The filename of the certificate to be downloaded.
ldap-server
host hostname:ip-address
The FQDN hostname or IPv4/IPv6 address of the remote LDAP server.
port port-number
The port number on which the LDAP server can be found.
download
protocol protocol-to-use
The protocol to use to access the remote download server.
user user-name
The account used to access the remote download server.
password password
The password for the account used to access the remote download server.
host host-ip-address
The IP address of the remote download server which contains the TPVM image.
directory remote-directory
The directory on the remote download server where the TPVM image is stored.
filename image-file-name
The filename of the TPVM image.

Usage Guidelines

PUT and PATCH operations are supported.

Examples

Example

The following example shows the setting of the DHCPv6 option for IPv6 address assignment to the management interface of the TPVM.

URI

http://host:80/rest/config/running/tpvm

curl -v -X PATCH 
-d "<ipv6><dhcpv6>true</dhcpv6></ipv6>" 
-u admin:password http://10.20.246.30:80/rest/config/running/tpvm/TPVM/interface/management/ipv6 -k -v

Example

The following example shows manual assignment of IPv6 address to the management interface of the TPVM. 

 curl -v -X PATCH 
-d "<ipv6-params><ipv6addr>23::54/24</ipv6addr><gw>12:23::5:32</gw></ipv6-params<" 
-u admin:password http://10.20.246.30:80/rest/config/running/tpvm/TPVM/interface/management/ipv6/ -k -v

Example

The following example shows the configuration of a trusted peer. 

 curl -v -X PATCH 
-d "<pwless><ipv6>12:3::65:76</ipv6><password>welcome123</password></pwless>"
-u admin:password http://10.20.246.30:80/rest/config/running/tpvm/TPVM/trusted-peer/ -k -v

curl -v -X PATCH -d "<trusted-peer><sudo-user>extrenetwo</sudo-user></trusted-peer>" -u admin:password http://10.20.246.30:80/rest/config/running/tpvm/TPVM/trusted-peer/ -k -v

admin:password http://10.20.246.30:80/rest/config/running/tpvm/TPVM/interface/management/ipv6/ -k -v
9037784-00 AA