Operation command

Note

The “.” displayed after the operation command is executed indicates waiting on operation result read status. One is shown every 5 seconds and the default setting is 30 seconds (completes when the 6th “.” is shown)

ping

Overview

Registers a ping task in the SACM and reads operation result.

Syntax

msh(tsa********)> ping <SA Code> <IPAddress> [size <Size>] [count <Count>] [targettime <Target Time>]

Parameter

Parameter name

Description

<SA Code>

SA code of the service adaptor on which the ping task is registered

<IPAddress>

IP address of the host to confirm communications with

  • IPv4 or IPv6

  • Cannot specify using host name

(Optional) <Size>

Transmitting packet length (byte) (0 - 65467)

(Optional) <Count>

Number of packets sent (1 - 128)

(Optional) <Target Time>

Task execute schedule date/time (Can specify up to end of next month. Format is yyyy/mm/dd hh:mm:ss).

When this option is specified, only the task registration is conducted and operation results are not displayed

Description

Registers a ping task in the SACM and displays whether or not there are operation results for the ping task. The number of transmissions, successes, and failure rate for the ping command are displayed in the operation results.

Output examples for commands are shown below.

msh(tsa********)> ping tsw00000000 127.0.0.1
..

5 packets transmitted, 5 packets received, 0.0% packet loss
msh(tsa********)>

Default value

Parameter / Option

Default value

<Target Time>

null

<Size>

56

<Count>

5

traceroute

Overview

Registers a traceroute task in the SACM and reads operation results.

Syntax

msh(tsa********)> traceroute <SA Code> <IPAddress> [maxhop <Max Hop>] [count <Count>] [targettime <Target Time>]

Parameter

Parameter name

Description

<SA Code>

SA code of the service adaptor on which the traceroute task is registered

<IPAddress>

IP address of the host to confirm communications with

  • IPv4 or IPv6

  • Cannot specify using host name

(Optional) <Target Time>

Task execute schedule date/time (Can specify up to end of next month. Format is yyyy/mm/dd hh:mm:ss).

When this option is specified, only the task registration is conducted and operation results are not displayed

(Optional) <Max Hop>

maximum hop count (0 - 255)

(Optional) <Count>

Number of packets transmitted for each hop (1 - 10)

Description

Registers a traceroute task in the SACM and displays whether or not there are operation results for the traceroute task. Operations results include traceroute number of hops and addresses of passed nodes.

Output examples for commands are shown below.

msh(tsa********)> traceroute tsw00000000 127.0.0.1
..

traceroute to 8.8.8.8, 30 hops max, 3 packets
 1 127.0.0.1
msh(tsa********)>

Default value

Parameter / Option

Default value

<Target Time>

null

<Max Hop>

30

<Count>

3

read-storage

Overview

Registers a read-storage task in the SACM and reads the operation result.

Syntax

msh(tsa********)> read-storage <SA Code> <storage> [targettime <Target Time>]

Parameter

Parameter name

Description

<SA Code>

SA code of the service adaptor on which the read-storage task is registered

<storage>

Config type to be read (startup, running, backup)

(Optional) <Target Time>

Task execute schedule date/time (Can specify up to end of next month. Format is yyyy/mm/dd hh:mm:ss).

When this option is specified, only the task registration is conducted and operation results are not displayed

Description

Registers a read-storage task in the SACM and displays the read config. Config text is displayed in the operation results. Not compatible with binary configs. Also, the types of configs that can be read will depend on the service adaptor model.

Output examples for commands are shown below.

msh(tsa********)> read-storage tsw00000000 running
.

interface.ge0.ipv4.address: dhcp
route.ipv4.0.destination: default
route.ipv4.0.gateway: dhcp
interface.pppoe0.id: sacm@example.jp
interface.pppoe0.password: sacm
interface.pppoe0.ipcp: enable
resolver.service: enable
resolver.1.address: dhcp
resolver.domain: hoge.jp
dns-forwarder.service: enable
dns-forwarder.1.address: ipcp
dns-forwarder.listen.ipv4.100.interface: pppoe0
dns-forwarder.2.address: 192.168.1.100
msh(tsa********)>

Default value

Parameter / Option

Default value

<Target Time>

null

reboot

Overview

Registers a reboot task on the SACM.

Syntax

msh(tsa********)> reboot <SA Code> [targettime <Target Time>]

Parameter

Parameter name

Description

<SA Code>

SA code of the service adaptor on which the reboot task is registered

(Optional) <Target Time>

Task execute schedule date/time (Can specify up to end of next month. Format is yyyy/mm/dd hh:mm:ss).

Description

Registers a reboot task in the service adaptor and displays the registered results. Does not wait for completion of actual reboot.

Output examples for commands are shown below.

msh(tsa********)> reboot tsw00000000
reboot: task was registered.
msh(tsa********)>

Default value

Parameter / Option

Default value

<Target Time>

null

read-status

Overview

Registers a read-status task in the SACM and reads operation result.

Syntax

msh(tsa********)> read-status <SA Code> <Module ID> <Show Command> [targettime <Target Time>]

Parameter

Parameter name

Description

<SA Code>

SA code of the service adaptor on which the read-status task is registered

<Module ID>

Target module ID

<Show Command>

Md command for which status is shown (commands that can be registered will depend on the service adaptor)

(Optional) <Target Time>

Task execute schedule date/time (Can specify up to end of next month. Format is yyyy/mm/dd hh:mm:ss).

When this option is specified, only the task registration is conducted and operation results are not displayed

Description

Registers a read-storage task in the service adaptor and reads the service adaptor status. Readable commands will vary depending on the service adaptor. Not compatible with multiple module execute function.

Output examples for commands are shown below.

msh(tsa********> read-status tsw00000000 show system
.

SA-W1 IPL Monitor version 1.00
SA-W1 Ver. 1.00 (Release)

H/Wrev  : ZZ
CPU     : Sheeva 88SV131 rev 1 (ARM9E-S core)
Serial  : (unknown)
DistID  : 0000-1111-2222-3333-4444-5555-6666-7777

Bootdev : flash

Date    : 2012/01/01 09:02:36 (JST)
Uptime  : 00:03 (since 2012/01/01 09:00:00)

Users   : 0 user
Loadavg : 0.27 (1min) 0.23 (5min) 0.10 (15min)
CPUstat : User 0.2%, Nice 0.0%, System 0.2%, Interrupt 0.0%, Idle 99.6%
Memory  : Total 128.00MB, Used 60.88MB (47.56%), Avail 67.12MB (52.44%)
msh(tsa********>

Default value

Parameter / Option

Default value

<Target Time>

null

clear-status

Overview

Registers a clear-status task in the SACM and reads operation result.

Syntax

msh(tsa********)> clear-status <SA Code> <Module ID> <Clear Command> [targettime <Target Time>]

Parameter

Parameter name

Description

<SA Code>

SA code of the service adaptor on which the clear-status task is registered

<Module ID>

Target module ID

<Clear Command>

Md command for which status is cleared (commands that can be registered will depend on the service adaptor)

(Optional) <Target Time>

Task execute schedule date/time (Can specify up to end of next month. Format is yyyy/mm/dd hh:mm:ss).

When this option is specified, only the task registration is conducted and operation results are not displayed

Description

Registers a clear-status task in the service adaptor and reads the service adaptor status. Readable commands will vary depending on the service adaptor. Not compatible with multiple module execute function.

Output examples for commands are shown below.

msh(tsa********)>  clear-status tsw00000000 0 clear nat-session ipv4
.

0 entries flushed from NAT table
msh(tsa********)>

Default value

Parameter / Option

Default value

<Target Time>

null

md-command

Overview

Registers a md-command task in the SACM and reads operation result.

Syntax

msh(tsa********)> md-command <SA Code> <Module ID> <Command> [targettime <Target Time>]

Parameter

Parameter name

Description

<SA Code>

SA code of the service adaptor on which the md-command task is registered

<Module ID>

Target module ID

<Command>

Command and argument executed on the service adaptor (commands that can be registered will depend on the service adaptor)

(Optional) <Target Time>

Task execute schedule date/time (Can specify up to end of next month. Format is yyyy/mm/dd hh:mm:ss).

When this option is specified, only the task registration is conducted and operation results are not displayed

Description

Registers an md-command task in the service adaptor and reads the command operation result. Readable commands will vary depending on the service adaptor.

Output examples for commands are shown below.

msh(tsa********)> md-command tsw00000000 0 ping 127.0.0.1 count 3
.

PING localhost (127.0.0.1): 44 data bytes
56 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=0.202 ms
56 bytes from 127.0.0.1: icmp_seq=1 ttl=255 time=0.188 ms
56 bytes from 127.0.0.1: icmp_seq=2 ttl=255 time=0.169 ms

----localhost PING Statistics----
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 0.169/0.187/0.202/0.017 ms
msh(tsa********>

Default value

Parameter / Option

Default value

<Target Time>

null