Top
Systemwalker Runbook Automation Reference Guide
Systemwalker

6.6 LogicalNetwork

When specifying an element in the Element Name cell using an XPath expression, assign "rc" as the namespace prefix.

Element
Name

Parent
Element

Element
Description

Component
Name

Component
Type

Component
Description

Data Type

# of

LogicalNetwork

Network node

id

Attribute

Unique identifier

ID

1

name

Attribute

Name

string

0..1

nickname

Attribute

Nickname

string

0..1

ipAddress

Attribute

Registered IP address

string

0..1

netmask

Attribute

Net mask

string

0..1

lastUpdate

Attribute

The date when data was last updated

dateTime

0..1

updateInfo

Attribute

Update information

string

0..1

Management

Element

Management information

-

0..1

Status

Element

Status information

-

0..1

LogicalNetworkConfiguration

Element

Settings information

-

0..1

Software

Element

Software information

-

0..1

Identity

Element

Identification information

-

0..1

Management

NetworkNode

Network node management information

VirtualTerminal

Element

Information required when network nodes are managed using VirtualTerminal

-

0..1

SNMP

Element

Information required when network nodes are managed using SNMP

-

0..1

VirtualTerminal

Management

Management information for VirtualTerminal

type

Attribute

Control protocol for virtual terminals
Either of the following:
"Telnet"
"SSH"

string

0..1

version

Attribute

String indicating the version of SSH being used
Either of the following:
"v1"
"v2"
* In principle, if both v1 and v2 can be used, use the higher version (v2)

string

0..1

manageIPAddress

Attribute

The IP address for logging in via Telnet
Not required if the same as the management IP address for the device

string

0..1

loginUsername

Attribute

User name for logging in via Telnet

string

0..1

loginPassword

Attribute

Password (encrypted) for logging in via Telnet

string

0..1

adminPassword

Attribute

Password (encrypted) for moving to privileged mode via Telnet
Not required if privileged mode is not needed

string

0..1

SNMP
(Management)

Management

Management information for SNMP

version

Attribute

String indicating the version of SNMP being used
Either of the following:
"v1"
"v2c"
"v3"
* In principle, if both v1 and v2 can be used, use the higher version (v2)

string

0..1

manageIPAddress

Attribute

IP address specified when getting and setting information using SNMP
Not required if the same as the management IP address for the device

string

0..1

readCommunity

Attribute

Community name (encrypted) used with SNMP-GET and GETNEXT

string

1

writeCommunity

Attribute

Community name (encrypted) used with SNMP-SET

string

0..1

Status
(NetworkNode)

NetworkNode

Network node statuses

Interfaces

Element

Information about the status of interfaces

-

0..1

DynamicRoutings

Element

Information about the status of routings

-

0..1

SpanningTrees

Element

Information about the status of spanning trees

-

0..1

LinkAggregations

Element

Information about the status of link aggregations

-

0..1

Redundancies

Element

Redundancy statuses

-

0..1

Interfaces
(Status)

Status

Interface statuses

Interface

Element

Interface status

-

0..*

Interface
(Status)

Interface status

id

Attribute

Unique identifier

ID

1

status

Attribute

String indicating the communications status of the interface

One of the following:
"unknown" # status unknown
"other" # status other than the following
"up" # Interface up
"down" # Interface down
"blocked" # Interface blocked

string

0..1

mode

Attribute

String indicating the communication protocol

One of the following:
"unknown" # status unknown
"other" # A protocol other than the following
"simplex-in # Uni-directional (receiving)
"simplex-out" # Uni-directional (sending)
"halfDuplex # Half duplex
"fullDuplex" # Full duplex

string

0..1

speed

Attribute

String indicating the actual communications speed

<Format>

"Number+Scale"

Eg
"10Gbps"
"100Mbps"
"unknown"
* For link aggregation or ether channels, use the communication speed for each individual interface, rather than the bundled communication speed.

Also, for full duplex interfaces, do not double the speed.

string

0..1

DynamicRoutings
(Status)

Status

Dynamic routing statuses

RoutingTable

Element

Routing table information

-

0..1

RoutingTable

DynamicRoutings

Routing table

RoutingInfo

Element

Routing information

-

0..*

RoutingInfo

RoutingTable

Routing information

id

Attribute

Unique identifier

ID

1

protocol

Attribute

Routing protocol
One of the following. (Taken from RFC1213, refer to this document for more information)
"other"
"local"
"netmgmt"
"icmp"
"egp"
"ggp"
...

string

0..1

type

Attribute

Route type
One of the following:
"other" # A route type not listed here
"invalid" # Invalid route
"direct" # Adjacent network
"indirect" # Non-adjacent network

string

0..1

destinationAddress

Attribute

Network address

string

0..1

gatewayAddress

Attribute

Gateway address

string

0..1

subnetmask

Attribute

Subnet mask value

int

0..1

nexthop

Attribute

IP address for the next hop

string

0..1

age

Attribute

Generation value for the routing information

int

0..1

metric1

Attribute

Metric value 1 for this route
This metric value depends on the protocol type, and may not exist
The same applies to the following metric values

int

0..1

metric2

Attribute

Metric value 2 for this route

int

0..1

metric3

Attribute

Metric value 3 for this route

int

0..1

metric4

Attribute

Metric value 4 for this route

int

0..1

metric5

Attribute

Metric value 5 for this route

int

0..1

SpanningTrees
(Status)

Status

Spanning tree statuses

STP

Element

STP status

-

0..1

STP
(Status)

SpanningTrees

STP status

STPInterface

Element

STP interface status

-

0..*

STPInterface
(Status)

STP

STP interface status

id

Attribute

Unique identifier

ID

1

status

Attribute

STP status for the interface. (Refer to RFC1493 for more information)
One of the following values:
"unknown"
"disabled"
"blocking"
"listening"
"learning"
"forwarding"
"broken"

string

0..1

LinkAggregations
(Status)

Status

Link aggregation statuses

LinkAggregation

Element

Link aggregation status

-

0..*

LinkAggregation
(Status)

LinkAggregations

Link aggregation status

id

Attribute

Unique identifier

ID

1

masterInterface

Attribute

Reference to the Interface(Configuration) element that is the master for this link aggregation

IDREF

0..1

Redundancies
(Status)

Status

Redundancy statuses

HotStandby

Element

Hot standby status

-

0..*

HotStandby
(Status)

Redundancies

Hot standby status

id

Attribute

Unique identifier

ID

1

masterIPAddress

Attribute

IP address of the node that is running as the master within this group

string

0..1

Configuration
(NetworkNode)
(Deprecated)

NetworkNode

Settings information for network nodes

Interfaces

Element

Settings information for logical interfaces

-

0..1

LinkAggregations

Element

Settings information for link aggregations

-

0..1

LoadBalancings

Element

Settings information for load balancers

-

0..1

VLANs

Element

Settings information for VLANs

-

0..1

SpanningTrees

Element

Settings information for spanning trees

-

0..1

Redundancies

Element

Settings information for redundancies

-

0..1

StaticRoutings

Element

Settings information for static routings

-

0..1

DynamicRoutings

Element

Settings information for dynamic routings

-

0..1

AddressTranslations

Element

Settings information for address translations

-

0..1

ACL

Element

Settings information for access controls

-

0..1

LogicalNetworkConfiguration

LogicalNetwork

Settings information for network nodes

Interfaces

Element

Settings information for logical interfaces

-

0..1

LinkAggregations

Element

Settings information for link aggregations

-

0..1

LoadBalancings

Element

Settings information for load balancers

-

0..1

VLANs

Element

Settings information for VLANs

-

0..1

SpanningTrees

Element

Settings information for spanning trees

-

0..1

Redundancies

Element

Settings information for redundancies

-

0..1

StaticRoutings

Element

Settings information for static routings

-

0..1

DynamicRoutings

Element

Settings information for dynamic routings

-

0..1

AddressTranslations

Element

Settings information for address translations

-

0..1

ACL

Element

Settings information for access controls

-

0..1

Interfaces
(Configuration)

Configuration

Settings information for logical interfaces

Interface

Element

Settings information for logical interfaces

-

0..*

Interface
(Configuration)

Interfaces

Logical interface settings information

id

Attribute

Unique identifier

ID

1

descr

Attribute

Interface identifier
MIB value for 'ifDescr'

string

0..1

type

Attribute

String indicating the type of interface
Basically the value of 'ifType' for MIB-2 for SNMP
except that this string can also be "unknown"
These values taken from RFC1573. Refer to this document for more information.
"unknown"
"other "
"regular1822"
"hdh1822"
"ddnX25"
"rfc877x25"
"ethernetCsmacd"
"iso88023Csmacd"
"iso88024TokenBus"
...

string

0..1

statusconfiguration

Attribute

Communication configuration status for the interface (as distinct from the operational status)
One of the following
"unknown" # status unknown
"other" # status other than the following
"up" # Interface up
"down" # Interface down
"blocked" # Interface blocked

string

0..1

connector

Attribute

Reference to the physical connector

IDREFS

0..1

mode

Attribute

Communication protocol setting
One of the following:
"unknown" # Unknown
"other" # A protocol other than the following
"Auto" # Automatic
"simplex-in" # Uni-directional (receiving)
"simplex-out" # Uni-directional (sending)
"halfDuplex" # Half duplex
"fullDuplex" # Full duplex

string

0..1

speed

Attribute

Communication speed setting
<Format>
"Number+Scale"

use "unknown" if the scale is unknown and "auto" if the speed is automatic
Eg
"10Gbps"
"100Mbps"
"auto"
* For link aggregation or ether channels, use the communication speed for each individual interface, rather than the bundled communication speed.

Also, for full duplex interfaces, do not double the speed.

string

0..1

status

Attribute

Reference to Interface(Status)

IDREF

0..1

NetworkAddress

Element

Network address

-

0..*

NetworkAddress

Interface
(Configuration)

Network address

ipAddress

Attribute

IP address

string

1

subnetmask

Attribute

Subnet mask

string

1

LinkAggregations
(Configuration)

Configuration

Link aggregation information

LinkAggregation

Element

Link aggregation information

-

0..*

LinkAggregation
(Configuration)

LinkAggregations

Link aggregation information

id

Attribute

Unique identifier

ID

1

aggregatedInterface

Attribute

Reference to the Interface(Configuration) that is being aggregated

IDREFS

0..1

status

Attribute

Reference to the LinkAggregation(Status)

IDREF

0..1

LoadBalancings

Configuration

Settings information for load balancers

SLBPolicy

Element

SLB settings information

-

0..*

SLBPolicy

LoadBalancings

Policy information for SLB allocation

id

Attribute

Unique identifier

ID

1

name

Attribute

Formal name

string

0..1

virtualIPAddress

Attribute

Virtual IP address

string

0..1

SLBService
(SLBPolicy)

Element

Allocated service

-

0..1

SLBNodePolicy

SLBContent

Policy information for SLB allocations for each node

id

Attribute

Unique identifier

ID

1

ipAddress

Attribute

IP address of the interface on the allocated node

string

0..1

port

Attribute

Specify the port number for the allocation target.
Not required in the default case where it is the same as the virtual port

int

0..1

protocol

Attribute

String indicating the protocol for the allocation target
Not required in the default case
"tcp"
"udp"
"any" (default case: either tcp or udp)

string

0..1

weight

Attribute

Weighting for the allocated node
Valid if the allocation protocol is "static weighted" (default = 1)

int

0..1

SLBService
(SLBPolicy)

SLBPolicy

Allocated service

id

Attribute

Unique identifier

ID

1

name

Attribute

Service name
Eg,
"http"
"ftp"
"dns"

string

0..1

virtualPort

Attribute

Used to specify the port number for the service when a user-defined local service is defined.

int

0..1

protocol

Attribute

String indicating the protocol for the allocation target
Not required in the default case
"tcp"
"udp"
"any" (default case: either tcp or udp)

string

0..1

type

Attribute

String indicating the service type
One of the following:
"TCPElse" # A TCP service not listed below
"UDPElse" # A UDP service not listed below
"Web" # Web server
"FTP" # FTP server
"Mail(POP3/IMAP)" # Mail server
"Mail(SMTP)" # Mail server
"DNS" # DNS server
"LDAP" # LDAP server

string

0..1

SLBContent

Element

Allocated content

-

0..*

SLBContent

SLBService

Allocated content

id

Attribute

Unique identifier

ID

1

url

Attribute

URL

string

0..*

dispersionType

Attribute

String indicating the balancing protocol
One of the following
"RoundRobin"
"WeightedRoundRobin"
"LeastConnections"

string

0..*

SLBNodePolicy

Element

SLB allocation policy information for each node

-

0..*

VLANs

Configuration

Settings information for VLANs

VLAN

Element

VLAN settings information

-

0..*

PVID

Element

PVID settings information

-

0..*

VLAN

VLANs

VLAN settings information

id

Attribute

Unique identifier

ID

1

vlanID

Attribute

VLAN ID

string

0..1

vlanName

Attribute

VLAN name

string

0..1

ipAddress

Attribute

IP address for when addresses are allocated to the VLAN

string

0..1

subnetmask

Attribute

Subnet mask for when addresses are allocated to the VLAN

string

0..1

taggedInterface

Attribute

Reference to an interface that has been set up as a tagged port for the VLAN
* Interfaces where link aggregation or EtherChannel has been set up have only a master interface reference

IDREFS

0..1

untaggedInterface

Attribute

Reference to an interface that has been set up as an untagged port for the VLAN
* Interfaces where link aggregation or EtherChannel has been set up have only a master interface reference

IDREFS

0..1

PVID

VLANs

PVD settings information

id

Attribute

Unique identifier

ID

1

vlanID

Attribute

VLANID (PVID value set for the interface)

string

0..1

interface

Attribute

Reference to the interface (configure) where the PVID has been set

IDREF

0..1

SpanningTrees
(Configuration)

Configuration

Settings information for spanning trees

STP

Element

Device STP settings information
For CST, etc., the multiplicity is 0, ..., 1. For MST, etc., the multiplicity is 0, ..., *.

STP

0..*

STP
(Configuration)

SpanningTree

Device STP settings information

id

Attribute

Unique identifier

ID

1

instance-id

Attribute

Holds the instance ID for the spanning tree.
(Required for MST)

string

0..1

forwardDelay

Attribute

Transmission delay time

int

0..1

helloTime

Attribute

Hello time

int

0..1

maxage

Attribute

Maximum aging time

int

0..1

maxhop

Attribute

Maximum hop count

int

0..1

priority

Attribute

Bridge priority

int

0..1

cost

Attribute

Path cost

int

0..1

linktype

Attribute

Only required if the protocol is RSTP
String indicating the link type
"point-to-point"
"shared"

string

0..1

protocol

Attribute

String indicating the protocol type
One of the following:
"STP"
"RSTP"

string

0..1

mode

Attribute

String indicating the operating mode
One of the following:
"CST"
"PVST"
"PVST+"
"MST"

string

0..1

vlanRange

Attribute

Specify the range of VLANIDs using commas and hyphens
Eg,

1,2,10-30
The multiplicity for VLANIDs depends on the mode
For PVST: 1
For MST: 1..*
For CST: 0

string

0..1

STPInterface

Element

Reference to the STP settings information for each interface

-

0..*

STPInterface
(Configuration)

STP

Port STP settings information

interface

Attribute

Reference to an interface where STP has been set up

IDREF

1

cost

Attribute

The value of the 'cost' attribute for this interface

int

0..1

priority

Attribute

The value of the 'priority' attribute for this interface

int

0..1

status

Attribute

Reference to the status for the STPInterface item

IDREF

0..1

Redundancies
(Configuration)

Configuration

Settings information for redundancies

HotStandby(Configuration)

Element

Hot standby information

-

0..*

HotStandby
(Configuration)

Redundancies

Hot standby information

id

Attribute

Unique identifier

ID

1

groupID

Attribute

The ID for a hot standby group that allows it to be uniquely identified within the device.
The appropriate ID varies depending on the protocol type.
VRRP ... VRID
HSRP ... GroupID
FJHS ... GroupID

string

0..1

protocol

Attribute

String indicating the protocol type
"other"
"VRRP"
"HSRP"
"FJHS"

int

0..1

virtualIPAddress

Attribute

Virtual IP address allocated to the HS group

string

0..1

interface

Attribute

Reference to the HS interface

IDREF

0..1

helloInterval

Attribute

Interval for transmitting hello packets (health packets)

int

0..1

authentication

Attribute

Flag indicating whether to use an authentication function

boolean

0..1

password

Attribute

Password to use when the authentication information is on

string

0..1

priority

Attribute

Priority
For the VRRP and HSRP protocols, higher values indicate higher priorities, but for the FJHS protocol, lower values indicate higher priorities

int

0..1

deadTime

Attribute

Time to wait before deciding to switch the active device if a hello packet is not received

int

0..1

preempt

Attribute

Flag indicating whether to run in preempt mode

boolean

0..1

delayTime

Attribute

Delay time for switching active devices

int

0..1

vmacAddress

Attribute

Virtual MAC address

string

0..1

ripmode

Attribute

Flag indicating whether to perform RIP linking

boolean

0..1

ripIPAddress

Attribute

IP address for the correspondent router when RIP linking is performed

string

0..1

status

Attribute

Reference to the HS status information

IDREF

0..1

TrackNode

Element

Node being tracked for HS switching

-

0..1

TrackInterface

Element

Interface being tracked for HS switching

-

0..1

FujitsuHotStandby

Element

Information specific to Fujitsu Hot Standby

-

0..1

FujitsuHotStandby

HotStandby

Information specific to Fujitsu Hot Standby

FujitsuHotStandbyGroup

Element

Fujitsu Hot Standby group

-

0..1

FujitsuHotStandbyPeerNode

Element

Correspondent node for Fujitsu Hot Standby

-

0..*

FujitsuHotStandbyGroup

FujitsuHotStandby

Fujitsu Hot Standby group

srcMacAddrCtrl

Attribute

Flag indicating whether to control source MAC addresses

boolean

0..1

workLimit

Attribute

If the total of the weights for correspondent routers used by the hot standby group that have errors exceeds this limit, the active and standby nodes will switch

int

0..1

mcuChangeDelay

Attribute

The time required for starting hot standby operations (in seconds) when switchovers occur during MCU redundant operations

int

0..1

FujitsuHotStandbyPeerNode

FujitsuHotStandby

Fujitsu Hot Standby correspondent node

id

Attribute

Unique identifier

ID

1

peerid

Attribute

ID of the correspondent router

string

0..1

weight

Attribute

Weight for the correspondent router

int

0..1

interface

Attribute

Reference to the interface for communicating with the correspondent router

IDREF

0..1

alivemode

Attribute

Flag indicating whether to send alive packets

boolean

0..1

alivepeerlimit

Attribute

Limit for the weights of correspondent routers

int

0..1

alivepeergroup

Attribute

Hot standby group ID for the correspondent router and corresponding weight
Use the following kind of format
<GroupID>@<weight>
Eg
1@10|11-20@3

string

0..1

aliveresendInterval

Attribute

Resend interval for alive packets

int

0..1

alivedeadInterval

Attribute

Interval for which alive packets are disabled

int

0..1

alivertyInterfval

Attribute

Interval for checking whether alive packets have recovered

int

0..1

alivesndInterval

Attribute

Interval for sending alive packets

int

0..1

alivetriggermode

Attribute

Flag used to enable or disable trigger mode for alive confirmation packets

boolean

0..1

TrackNode

HotStandby

Node monitored for Hot Standby switching

ipAddress

Attribute

IP address of the monitored node

string

0..1

resendInterval

Attribute

Packet resend interval

int

0..1

normalInterval

Attribute

Normal packet transmission interval

int

0..1

errorInterval

Attribute

Transmission interval when packet errors occur

int

0..1

timeout

Attribute

Timeout time

int

0..1

priority

Attribute

Priority subtracted when the monitored node fails

int

0..1

TrackInterface

HotStandby

Interface monitored for Hot Standby switching

interface

Attribute

Reference to the monitored interface (Configuration)

IDREF

1

priority

Attribute

Priority subtracted when the monitored interface fails

int

0..1

StaticRoutings

Configuration

Settings information for static routings

StaticRouting

Element

Static routing information

-

0..*

StaticRouting

StaticRoutings

Static routing information

id

Attribute

Unique identifier

ID

1

destinationAddress

Attribute

Destination address

string

0..1

subnetmask

Attribute

Destination subnet mask

int

0..1

gatewayAddress

Attribute

Gateway address

string

0..1

DynamicRoutings
(Configuration)

Configuration

Settings information for dynamic routings

RIP

Element

RIP information

-

0..1

OSPF

Element

OSPF information

-

0..1

RoutingNetwork

Element

Network information

-

0..*

AccessList

Element

Access list

-

0..*

RouteMap

Element

Route map

-

0..*

RIP

DynamicRoutings

RIP settings information

id

Attribute

Unique identifier

ID

1

invalidInterval

Attribute

Time to wait before deciding that a RIP route is disabled after packets stop being received on that route

int

0..1

updateInterval

Attribute

Transmission interval for route notification packets

int

0..1

holddownInterval

Attribute

Time to suppress update packet reception for routes that are held down

int

0..1

flushInterval

Attribute

Time to wait before deleting a route from the RIP database

int

0..1

neigborIPAddress

Attribute

IP address of the adjacent router node

string

0..1

metric

Attribute

Default metric

int

0..1

version

Attribute

String indicating the RIP version
One of the following:
"v1"
"v2"
"v1&v2"

string

0..1

autosummary

Attribute

Flag indicating whether to merge subnet routes into network level routes (V2 only)

boolean

0..1

defaultInformation

Attribute

Flag indicating whether to notify default routes

boolean

0..1

routingnetwork

Attribute

Reference to the network for which routes are being switched

IDREFS

0..1

outputdelay

Attribute

Transmission delay time

int

0..1

RIPInterface

Element

RIP settings for each interface

-

0..*

RIPOffsetList

Element

Metric offset value

-

0..*

RIPDistance

Element

Distance for RIP route information

-

0..*

DistributeList

Element

Settings information for routing distribution

-

0..*

Redistribute

Element

Settings information for routing redistribution

-

0..*

RIPInterface

RIP

RIP interface information

id

Attribute

Unique identifier

ID

1

inputVersion

Attribute

Version of RIP for receiving
One of the following:
"off"
"v1"
"v2"
"v1&v2"

string

0..1

outputVersion

Attribute

Version of RIP for sending
One of the following:
"off"
"v1"
"v2"
"v1&v2"

string

0..1

metric

Attribute

Metric value

int

0..1

interface

Attribute

Reference to the interface that has been set

IDREF

0..1

passiveInterface

Attribute

Flag indicating whether this interface is a passive interface

boolean

0..1

splithorizon

Attribute

Flag indicating whether the splithorizon function has been enabled

boolean

0..1

triggerUpdate

Attribute

Flag indicating whether to perform RIP trigger updates

boolean

0..1

key

Attribute

Authentication key number

string

0..1

keychain

Attribute

Authentication key

string

0..1

keystring

Attribute

Authentication string

string

0..1

RIPOffsetList

RIP

Offset for RIP metrics

id

Attribute

Unique identifier

ID

1

way

Attribute

String indicating the metric application direction
One of the following:
"in" # receiving
"out" # sending

string

0..1

interface

Attribute

Reference to the interface to which the offset applies
If no instances are given, the offset applies to all interfaces

IDREF

0..1

accesslist

Attribute

Reference to an access list

IDREF

0..1

offset

Attribute

Offset value (1... 16)

int

0..1

RIPDistance

RIP

Distance for RIP route information

id

Attribute

Unique identifier

ID

1

weight

Attribute

Distance value

int

0..1

accesslist

Attribute

Reference to an access list

IDREF

0..1

DistributeList

RIP
OSPF

Settings information for routing distribution

type

Attribute

String indicating the type
"in" # receiving
"out" # sending

string

0..1

accesslist

Attribute

Reference to an access list

IDREF

0..1

Redistribute

RIP
OSPF

Settings information for routing redistribution

protocol

Attribute

String indicating the protocol type
One of the following:
"connected" # the protocol that is currently connected
"static" # static routing
"RIP"
"OSPF"
"BGP"

string

0..1

metric

Attribute

Metric value

int

0..1

metricType

Attribute

String indicating the metric type (for OSPF only)
One of the following:
"Type-1Cost"
"Type-2Cost"

string

0..1

routemap

Attribute

Reference to a route map

IDREF

0..1

OSPF

DynamicRoutings

OSPF settings information

id

Attribute

Unique identifier

ID

1

extraAreaDistance

Attribute

Priority (distance) for routes outside the AS

int

0..1

intraAreaDistance

Attribute

Priority (distance) for routes inside the AS

int

0..1

interAreaDistance

Attribute

Priority (distance) for routes between ASs

int

0..1

metric

Attribute

Metric value

int

0..1

metrictype

Attribute

String indicating the metric type
One of the following:
"Type-1Cost"
"Type-2Cost"

string

0..1

routerID

Attribute

Router ID

string

0..1

spfdelay

Attribute

Delay (in seconds) from the time when a topology change is detected until the SPF calculation starts

int

0..1

spfholdtime

Attribute

Minimum waiting interval (in seconds) until the next SPF calculation

int

0..1

defaultInformation

Attribute

Flag indicating whether to notify the default gateway

boolean

0..1

routingnetwork

Attribute

Reference to the network for which routes are being switched

IDREFS

0..1

OSPFInterface

Element

OSPF settings information for each interface

-

0..*

OSPFArea

Element

OSPF area information

-

0..*

DistributeList

Element

Settings information for routing distribution

-

0..*

Redistribute

Element

Settings information for routing redistribution

-

0..*

OSPFInterface

OSPF

OSPF settings information for each interface

id

Attribute

Unique identifier

ID

1

authenticationType

Attribute

String indicating the type of authentication
One of the following:
"simple"
"message-digest"
* Required if authentication is performed

int

0..1

interface

Attribute

Reference to the interface

IDREF

0..1

authenticationKey

Attribute

Authentication keyword for OSPF packets
(only required if authenticate is performed)

string

0..1

authenticationID

Attribute

Authentication keyword number
(only if the authentication type is "message-digest")

int

0..1

cost

Attribute

Packet transmission cost

int

0..1

deadInterval

Attribute

Restriction time until hello packets arrive

int

0..1

helloInterval

Attribute

Transmission interval for the hello packets sent from the interface

int

0..1

passive

Attribute

Flag indicating whether the interface is passive

boolean

0..1

priority

Attribute

Router priority

int

0..1

retransmitInterval

Attribute

Interval for resending LSAs to the OSPF neighbor under the interface

int

0..1

transmitDelay

Attribute

Transmission delay time for LSUpdate packets

int

0..1

area

Attribute

Reference to OSPF area information

IDREF

0..1

routingnetwork

Attribute

Reference to the network being routed

IDREF

0..1

OSPFArea

OSPF

id

Attribute

Unique identifier

ID

1

areaID

Attribute

OSPF area identifier

string

0..1

areaType

Attribute

String indicating the OSPF area type
One of the following:
"nssa" # Quasi-stub area
"backbone" # Backbone area
"stub" # Stub area

string

0..1

summary

Attribute

The meaning of this element depends on the area type.
<stub>
Flag indicating whether to notify aggregate link information to the stub area when running as an area border router
<nssa>

Flag indicating whether to issue Type-3-LSAs corresponding to routes learnt from other areas to NSSA areas

boolean

0..1

routingnetwork

Attribute

Reference to the address for the network where routes are to be aggregated (only if the area type is "backbone")

IDREF

0..1

advertise

Attribute

Flag indicating whether to notify Type-3-LSAs of aggregated routes (only if the area type is "backbone")

boolean

0..1

redistribution

Attribute

Flag indicating whether to issue Type-7-LSAs corresponding to ASE-LSAs to NSSA areas (only if the area type is "nssa")

boolean

0..1

defaultInformation

Attribute

Flag indicating whether to notify Type-7 default route information within NSSA areas when the router is running as an AS border router (only if the area type is "nssa")

boolean

0..1

metric

Attribute

Metric value for notifying default routes (only if the area type is "nssa")

int

0..1

metrictype

Attribute

Metric type for notifying default routes

Metric type
One of the following:
"Type-1Cost"
"Type-2Cost"
(only if the area type is "nssa")

string

0..1

translate-always

Attribute

Flag indicating whether to set the routers learnt from NSSA areas as area border routers to the backbone area as the routers that distribute routes using Type-5-LSAs (only if the area type is "nssa")

boolean

0..1

RoutingNetwork

DynamicRoutings

Routing network information

id

Attribute

Unique identifier

ID

1

networkaddress

Attribute

Network address

string

0..1

subnetmask

Attribute

Subnet mask

int

0..1

areaID

Attribute

Area ID (only for OSPF)

int

0..1

AccessList

DynamicRoutings

Access control list

id

Attribute

Unique identifier

ID

1

accesslistID

Attribute

Access list ID within the device

string

0..1

AccessPolicy

Element

Access control policy

-

0..*

AccessPolicy

AccessList

Access control policy

permit

Attribute

Allow (true) or deny (false)

boolean

0..1

type

Attribute

Type of control target
One of the following:
"network" # network
"host" # host
"all" # all

string

0..1

ipAddress

Attribute

IP address to be allowed or denied

string

0..1

subnetmask

Attribute

Subnet mask

int

0..1

RouteMap

DynamicRoutings

Route map information

id

Attribute

Unique identifier

ID

1

permit

Attribute

Allow (true) or deny (false)

boolean

0..1

tagname

Attribute

Route map tag name

string

0..1

RouteMatch

Element

Route matching information

ID

0..*

RouteSet

Element

Route settings information

ID

0..*

RouteMatch

RouteMap

Route matching information

type

Attribute

String indicating the type of match target
One of the following:
"interface"
"path"
"ip"
"nexthop"
"metric"

string

0..1

value

Attribute

Value to be compared

string

0..1

accessList

Attribute

Reference to an access list

Only if the type of match target is "path", "ip" or "nexthop"

IDREF

0..1

RouteSet

RouteMap

Route settings information

type

Attribute

String indicating the type of target to be set
One of the following:
"interface"
"ip"
"nexthop"
"metric"
"metrictype"
"weight"

string

0..1

value

Attribute

Value to be set

string

0..1

AddressTranslations

Configuration

Settings information for address translations

NAT

Element

NAT information

NAT

0..*

NAT

AddressTranslations

NAT information

id

Attribute

Unique identifier

ID

1

name

Attribute

NAT policy name

string

0..1

type

Attribute

String indicating the NAT type
One of the following:
"SNAT" # source NAT
"DNAT" # destination NAT
"NAPT" # IP masquerade

string

0..1

externalAddress

Attribute

External address(es)
Use the following format to specify multiple addresses:
Eg, 10.24.8.[1-10,20]

string

0..1

internalAddress

Attribute

Internal address(es)
Use the following format to specify multiple addresses:
Eg, 10.24.8.[1-10,20]

string

0..1

externalPort

Attribute

External port number
Use "0" to indicate a wildcard

int

0..1

internalPort

Attribute

Internal port number
Use "0" to indicate a wildcard

int

0..1

ACL

Configuration

Settings information for access control

AccessControlInterface

Element

Access control settings information for each interface

-

0..*

AccessControl

Element

Access control information

-

0..*

FilteringPolicy

Element

Filtering information

-

0..*

AccessControlInterface

ACL

Settings information for access control for each interface

id

Attribute

Unique identifier

ID

1

interface

Attribute

Reference to settings information (Interface(Configuration)) for logical interfaces where ACL settings have been made

IDREF

1

accessControl

Attribute

Reference to settings information for access control

IDREFS

1

AccessControl

ACL

Access control information

id

Attribute

Unique identifier

ID

1

name

Attribute

Access control name

string

0..1

way

Attribute

Control direction
One of the following:
"in" # Reception
"out" # Transmission
"any" # Both reception and transmission
"reverse" # Both reception and transmission (reversing the IP address and port number for the sender and destination when receiving)
"in-enciphered" # Evaluation using plain text when decrypting encrypted packets sent to the device

string

0..1

action

Attribute

Control method
One of the following:
"accept" # Allow
"drop" # Discard
"reject" # Deny
"redirect" # Forward
"remove" # Delete content (HTTP) etc
"restrict" # Allow when connecting, discard when disconnecting

string

0..1

priority

Attribute

Priority

int

0..1

nat

Attribute

Reference to NAT translation information

IDREF

0..1

filteringPolicy

Attribute

Reference to filtering information

IDREF

1

FilteringPolicy

ACL

Filtering information

id

Attribute

Unique identifier

ID

1

name

Attribute

Filtering policy name

string

0..1

judge

Attribute

Judgment method
One of the following:
"any" # Matches at least one
"all" # Matches all

string

0..1

MatchAnyFilter

Element

Match any filter

-

0..*

MACAddressFilter

Element

MAC address filter

-

0..*

IPAddressFilter

Element

IP address filter

-

0..*

PortFilter

Element

Port filter

-

0..*

ProtocolFilter

Element

Protocol filter

-

0..*

MatchAnyFilter

FilteringPolicy

Match any filter

id

Attribute

Unique identifier

ID

1

MACAddressFilter

FilteringPolicy

MAC address filter

id

Attribute

Unique identifier

ID

1

type

Attribute

Type
One of the following:
"dest" # destination MAC address
"source" # source MAC address

string

0..1

operator

Attribute

Relational operator
One of the following:
"= "
"!= "

string

0..1

macaddress

Attribute

MAC address
If there are multiple MAC addresses, separate addresses using commas ",".
To specify a range of consecutive MAC addresses, specify the first and last MAC address, separated by a hyphen "-"

string

0..1

IPAddressFilter

FilteringPolicy

IP address filter

id

Attribute

Unique identifier

ID

1

type

Attribute

Type
One of the following:
"dest" # destination IP address=0,
"source" # source IP address

string

0..1

operator

Attribute

Relational operator
One of the following:
"= "
"!= "

string

0..1

command

Attribute

Address
If there are multiple addresses, separate addresses using commas ",".
To specify a range of consecutive addresses, specify the first and last MAC address, separated by a hyphen "-"
For subnet addresses, enter the mask length at the end as "/XX"

string

0..1

PortFilter

FilteringPolicy

Port filter

id

Attribute

Unique identifier

ID

1

type

Attribute

Type
One of the following:
"dest" # destination port number
"source" # source port number

string

0..1

operator

Attribute

Relational operator
One of the following:
"= "
"!= "
"<=,"
">="
"<,"
">"

string

0..1

port

Attribute

Port number
If there are multiple port numbers, separate port numbers using commas ",".
To specify a range of consecutive port numbers, specify the first and last port numbers separated by a hyphen "-".

string

0..1

protocol

Attribute

Protocol type
One of the following:
"tcp"
"udp"
"tcp-udp"

string

0..1

ProtocolFilter

FilteringPolicy

Protocol filter

id

Attribute

Unique identifier

ID

1

operator

Attribute

Relational operator
One of the following:
"= "
"!= "
"<=,"
">="
"<,"
">"

string

0..1

protocol

Attribute

Protocol number
If there are multiple protocol numbers, separate port numbers using commas ",".
To specify a range of consecutive protocol numbers, specify the first and last protocol numbers separated by a hyphen "-".

string

0..1

Software

NetworkDevice

Device software (firmware)

name

Attribute

Software name
Eg, "IOS (tm) 3600 Software (C3620-I-M)"

string

0..1

version

Attribute

Software version
The notation method depends on the model, so the format is not specified here. Use the device specific notation as is.
Eg, Version 12.1(11)

string

0..1

compileDate

Attribute

Compilation date
The notation method depends on the model, so the format is not specified here. Use the device specific notation as is.
Eg, "02-Oct-01 21:40"

string

0..1

Identity

NetworkDevice

Device identification information

vendorID

Attribute

Vendor identifier
Eg, "Fujitsu"

string

0..1

SNMP

Element

Information for identifying the device via SNMP

string

0..1

SNMP
(Identity)

Identity

SNMP identification information

sysDescr

Attribute

The 'sysDescr' string for the device
Refer to RFC1213 for more information

string

0..1

sysObjectId

Attribute

The 'sysObjectId' string for the device
Refer to RFC1213 for more information

string

0..1