Definitions of Events

An N1 Provisioning Server generates chargeable events at the farm level and at the resource pool level. All chargeable event messages include the time expressed in UTC, a sequence number and details of the event. All chargeable event messages have the following common format:

event-message  ::= utc-date-time “,” sequence-info “,” event-info “,” event-details

event-info     ::= “event” “=” event

event          ::= “resource” | “control” | “farm”

event-details  ::= rl-event-desc	
	                | cl-event-desc
	                | farm-event-desc

The sequence number uniquely identifies the event within an N1 Provisioning Server. A sequence has the following definition:

sequence-info	::=	“seq”	“=”	fabric-name	“:”	sequence-id

The chargeable event records contain the event timestamp in the time zone of the control plane server that generated the data.

Typically, events are described as a sequence of name/value pairs. Unless explicitly indicated, all values are enclosed in double quotation marks to allow for easy transition to XML formats.

General Definitions

The following definitions apply to the values of all farm-level and resource pool definitions described in the preceding sections:

number ::= digit { digit }

digit  ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"

where number represents a decimal number.

name    ::= letter { letter | digit | special }	| quoted-string

special ::= "." | "-" | "_"

where value::= represents a contiguous sequence of nonwhite space characters.

You must enclose a name or value that includes a comma (",") in double quotation marks. In such cases, a double quotation mark is escaped as two contiguous double quotations (that is, "" represents a quoted double quote).

fabric-name, account-name, image-name, and dns-name are defined to be a name.

Thus sequence-id, account-id, device-id, farm-id, device-id, disk-id, vlan-id, and disk-size are all defined to be a number. Both disk-size and mask-len are also defined to be a number.

IDs are set and generated by the N1 Provisioning Server. Names are generated by users of the N1 Provisioning Server. For example, image-name is specified by a user operating the Control Center.

subnet-mask is a quoted string representing a TCP/IP subnet mask. Typically, the string has the format of an IP address.

ipaddr	::=	number	"."	number	"."	number	"."	number	

Where number is in the range 0 ... 255. An IP address is defined to have the same format as a subnet mask.

The definition of utc-date-time is as follows:

utc-date-time ::= utc-date utc-time	

utc-date      ::= year	"-"	month	"-"	day

utc-time      ::= hours	":"	minutes	":"	seconds	[ "." subseconds ]

where year is a number, month is a number in the range 1...12, and day is a number in the range 1..31.

hours is a number in the range 0...23, minutes and seconds are numbers in the range 0...59. subseconds is a number.

A wml-description is the WML architecture for the specified device. The architecture is defined to be a quoted string.

Farm-Level Events

Farm-level events indicate when a farm is created or deactivated. The event messages indicate the customer with which the farm ID is associated so that you can subsequently associate resource pool events with a farm-level event. Farm-level events are structured like the following example:

farm-event-desc ::= farm-operation	","	farm-info	","	farm-state-info	
","	account-info

farm-operation  ::= "op" "=" farm-op

farm-op         ::=	 "add" | "del" | "update"

farm-info       ::= "farm-id" "=" 	farm-id

farm-state-info ::= "state" "=" farm-state

farm-state      ::= "new" | "active" | "standby" | "deactivated"

account-info    ::= "account-id" "=" account-id [ "," "name" "=" account-name ]

2003-01-20
14:00:01.0,newyork:1001,event="farm",op="add",farm-id="99",state="ACTIVE",
account-id="jdoe"

1001 is the sequence ID of this event. Farm 99 was added and it is in state ACTIVE. This event occurred at 14:00:01 on Jan. 20, 2003.

2003-01-20 
19:10:01.0,newyork:1022,event="farm",op="update",farm-id="99", state="UPDATE",account-id="jdoe"

1022 is the sequence ID of this event. Farm 99 was updated, it is in state UPDATE. This event occurred at 19:10:01 on Jan, 20, 2003.

Resource Pool Events

Resource pool events indicate when a resource is allocated, made available, fails, and is deallocated. The definition of a resource pool event is as follows:

rl-event-desc ::= rl-operation "," farm-info "," category-info "," resource-desc [ "," account-info ]

rl-operation  ::= "op" "=" rl-op

rl-op         ::= "add" | "del" | "update" | "avail" | "fail" | "reboot"

farm-info     ::= "farm-id" "=" farm-id	

category-info ::= "category" "=" category

category      ::= "device" | "disk" | "vlan" | "subnet" | "ipaddress"

resource-desc ::= device-desc | disk-disc | vlan-desc | subnet-desc | ipaddr-desc

The following table describes the types of event and when they occur:

All events referring to devices include the device ID. If the events refer to disks, the events include the disk ID. The device IDs and disk IDs enable you to accurately track all devices and disks.

Devices

The definition of a device event is as follows:

device-desc      ::= deviceclass-info "," devicetype-info "," deviceid-info

deviceclass-info ::= "class" "=" device-class

device-class     ::= "lb" | "fw" | "server" | "nas" | "ethport"

devicetype-info  ::= "type" "=" wml-description

deviceid-info    ::= "device-id" "=" device-id

"ethport" is the name given to unmanaged Ethernet devices or other such devices with an IP address.

2003-02-01

10:00:00.0,newyork:2998,event="resource",op="add",farm-id="99",
category="device",class="server",type="sun-svr-blade",device-id="50101",
service-units="0"

On Feb 1, 2003 at 10:00:00, in the newyork I-Fabric, sequence id 2998, a resource was added to farm 99. This resource was a device. The class of device was a server. The type of the server was a sun-svr-blade server. The ID of the actual device allocated was 50101.

Disks

The definition of a disk event is as follows:

disk-desc      ::= diskclass-info "," disktype-info "," diskid-info size-info "," [ "," image-info]

diskclass-info ::= "location" "=" disk-location

disk-location  ::= "internal" | "external"	

disktype-info  ::= "type" "=" wml-description

diskid-info	    ::= "disk-id" "=" disk-id

size-info      ::= "size" "=" disk-size

image-info     ::= "image-name 	"=" image-name

2003-02-01

10:00:10.0,newyork:2999,event="resource",op="add",farm-id="99",
category="disk",location="internal",type="local",disk-id="62",
size="1000000000",image-name="small_solaris_blade"

On February 1, 2003 at 10:00:10 in the newyork I-Fabric, sequence id 2999, a resource was added to farm 99. This resource was a disk. The disk's location is internal (that is, physically located inside of a server). The disk type is local. The physical disk ID is 62. The size in bytes is 1000000000. The image placed on the disk is small_solaris_blade.

Virtual Local Area Networks (VLANs)

The definition of VLAN events is as follows:

vlan-desc ::= "vlan" "=" vlan-id

2003-02-01

10:00:25.0,newyork:3002,event="resource",op="add",farm-id="99",
category="vlan",vlan="22"

On Feb 1, 2003 at 10:00:25, in the newyork I-Fabric, a VLAN was added to farm 99. The VLAN ID is 22.

Subnets

The definition of subnet events is as follows:

subnet-desc      ::=  subnet-mask-info "," masklen-info "," addr-type-info

subnet-mask-info ::= "subnet-mask" "," subnet-mask

masklen-info     ::= "mask-len" "," mask-len

addr-type-info   ::= "type" "," addr-type

addr-type        ::= "internal" | "external"

2003-02-01

10:00:15.0,newyork:3000,event="resource",op="add",farm-id="99",
category="subnet",subnet="10.10.0.81",mask-len="28",type="external"

On Feb 1, 2003 at 10:00:15 in the newyork I-Fabric, event 3000 was generated. A resource was added to farm 99. The resource was a subnet. The subnet is located at 10.10.0.81, the mask length of the subnet is 28, and the type of the subnet is external.

IP Addresses

The definition of IP address events is as follows:

ipaddr-desc ::= ipaddr-info "," addr-type-info [ "," dns-name]

ipaddr-info ::= "ipaddress" "="	 ipaddress

2003-02-01

10:00:20.0,newyork:3001,event="resource",op="add",farm-id="99",
category="ipaddress",ipaddress="10.10.0.83",type="external",server1

On Feb 2. 2003 at 10:00:20 in the newyork I-Fabric event 3001 was generated. The event was a resource event. A resource was added to farm 99. The resource was an IP address. The IP address was 10.10.0.83, it is an external IP address, and the DNS name that maps to that IP address is server1.