switches.proto

syntax = "proto2";

import "simple-storage.proto";
import "commons.proto";

package com.ruckuswireless.scg.protobuf.icx;

/**
 * @internal
 **/
enum CliTask {
    NONE = 1;
    RELOAD = 2;
    DELETE = 3;
    DISCONNECT = 4;
}

/**
 * @internal
 **/
enum RegistrationStatus {
    UNKNOWN = 1;
    REGISTRATION_PENDING = 2;
    PENDING = 3;
    OVERLOADING = 4;
    APPROVED = 5;
    REJECTED = 6;
}

/**
 * @internal
 **/
message GpbNetworkSwitch {
    option (com.ruckuswireless.scg.protobuf.storage.entity) = true;
    option (com.ruckuswireless.scg.protobuf.storage.category) = DEVICE;
    optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; //Switch/Stack Router ID + MAC
    optional SwitchConfig switchConfig = 2;
    optional SwitchStatus switchStatus = 3;
}

/**
 * @internal
 **/
message SwitchConfig {

    enum ProvisionState {
        INIT = 1;
        FAILURE = 2;
        SUCCESS = 3;
    }

    option (com.ruckuswireless.scg.protobuf.storage.category) = CONFIG;
    optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true];
    optional string hostName = 2;
    optional RegistrationStatus registrationStatus = 3;
    optional string activeIpList = 4;
    optional string passiveIpList = 5;
    optional string sshAccountName = 6;
    optional string switchRsaPublicKey = 7;
    optional string switchRsaPrivateKey = 8;
    optional string szSshPublicKey = 9;
    optional string syslogIpAddress = 10;
    optional int32 syslogPort = 11;
    optional string snmpIpAddress = 12;
    optional int32 snmpPort = 13;
    optional string cliIpAddress = 14;
    optional int32 cliPort = 15;
    optional string domainId = 16;
    optional string tenantId = 17;
    optional string switchGroupLevelOneId = 18;
    optional string switchGroupLevelTwoId = 19;
    optional string switchSshKey = 20;
    optional string serialNumber = 21;
    optional string routerId = 22;
    optional string szNodeAttached = 23;
    optional CliTask cliTask = 24 [default = NONE];
    optional string macAddress = 26;
    optional int64 lastBackupTime = 27;
    optional int64 lastRestoreTime = 28;
    optional string lastBackupStatus = 29;
    optional string lastRestoreStatus = 30;
    optional string ipAddress = 31;
    optional int64 createdTimestamp = 32;
    optional int64 lastConfigTime = 33;
    optional int32 szHttpClientPort = 34;
    optional int32 supportedCsl = 35;
    optional bool cacheFactoryDefault = 36;
    optional bool isCslRequested = 37;
    optional string cloudPort = 38;
    optional string licenseType = 39;
    optional string firmwareUpdateScheduleId = 40;
    optional string firmwareUpdateScheduledTime = 41;
    optional string firmwareUpdateModifiedTime = 42;
    optional string firmwareUpdateStatus = 43;
    optional string firmwareUpdateToVersion = 44;
    optional bool isMigration = 45;
    optional ProvisionState provisionState = 46;
    optional bool operational = 47;
}

/**
 * @internal
 */

message PowerSupplyGroup {
    option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP;
    optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true];
    optional string stackId = 2;
    optional int32 powerSlotNum = 3;
    optional string powerSupplyType = 4;
    optional string powerSupplyStatus = 5;
    optional string serialNumber = 6;
}

message TempThresholdGroup {
    option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP;
    optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true];
    optional string stackId = 2;
    optional int32 slotNum = 3;
    optional int32 tempThreshold = 4;
    optional double temperatureValue = 5;
}

message FanGroup {
    option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP;
    optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true];
    optional string stackId = 2;
    optional int32 slotNum = 3;
    optional string type = 4;
    optional string status = 5;
    optional string serialNumber = 6;
}

message SwitchStatus {
    required string id = 1; 
    optional string firmware = 2; 
    optional string model = 3; 
    optional string defaultGateway = 4; 
    optional int32 numOfPorts = 5; 
    optional string natIp = 6; 
    optional string status = 7; 
    optional bool poeAvailable = 8; 
    optional uint64 lastBackup = 9; 
    optional uint64 cpu = 10; 
    optional uint64 memory = 11;
    optional string uptime = 12; 
    optional int32 alerts = 13;
    optional bool isStack = 14; 
    optional string stackId = 15; 
    optional int32 priority = 16; 
    optional string modules = 17; 
    optional string domainId = 18;
    optional string groupId = 19; 
    optional uint64 lastUpdateTimeInMillis = 20; 
    optional string switchName = 21; 
    optional string tenantId = 22; 
    optional string switchGroupLevelOneId = 23; 
    optional string switchGroupLevelTwoId = 24; 
    optional string serialNumber = 25; 
    optional string unitSerialNumbers = 26; 
    optional string portModuleIds = 27; 
    optional string partitionInUse = 28;
    optional string switchMode = 29; 
    optional string switchSWVersion = 30;
    optional int32 numOfUnits = 31; 
    optional int32 poeUtilization = 32; 
    optional int32 poeTotal = 33; 
    optional int32 poeFree = 34; 
    optional string family = 35;
    optional string cloudPort = 43;
    optional string domainName = 44;
    optional string switchGroupLevelOneName = 45;
    optional string switchGroupLevelTwoName = 46;
    optional string powerSupplyGroups = 47;
    optional string fanGroups = 48;
    optional string ipAddress = 49;
    optional string subnetMask = 50;
    optional string staticOrDynamic = 51;
    optional string dns = 52;
    optional string temperatureGroups = 53;
    optional uint64 totalMemory = 54;
    optional uint64 freeMemory = 55;
    optional bool hasPoECapability = 56;
    optional bool operational = 57;
    optional string reservedField1 = 58;
    optional string reservedField2 = 59;
    optional string reservedField3 = 60;
    optional string reservedField4 = 61;
6.1.1 update
optional LocalSyncRunningStatus localsyncStatus = 62; } message SwitchStats { required string id = 1; optional int64 timestamp = 2; optional string switchSerialNum = 3; optional int64 tx = 4; optional int64 rx = 5; optional int64 txRx = 6; optional int64 txPkt = 7; optional int64 rxPkt = 8; optional int64 txRxPkt = 9; optional int64 txRate = 10; optional int64 rxRate = 11; optional int64 txRxRate = 12; optional int64 cpu = 13; optional int64 memory = 14; optional string domainId = 15; optional string tenantId = 16; optional string switchGroupLevelOneId = 17; optional string switchGroupLevelTwoId = 18; optional string domainName = 19; optional string switchGroupLevelOneName = 20; optional string switchGroupLevelTwoName = 21; optional int64 multicastOut = 22; optional int64 multicastIn = 23; optional int64 broadcastOut = 24; optional int64 broadcastIn = 25; optional int64 crcErr = 26; optional int64 outErr = 27; optional int64 inErr = 28; optional int64 unicastOut = 29; optional int64 unicastIn = 30; optional bool collectorExecuted = 31; } message PortStats { required string id = 1; optional int64 timestamp = 2; optional string switchSerialNum = 3; optional string portMac = 4; optional int64 tx = 5; optional int64 rx = 6; optional int64 txRx = 7; optional int64 txPkt = 8; optional int64 rxPkt = 9; optional int64 txRxPkt = 10; optional int64 txRate = 11; optional int64 rxRate = 12; optional int64 txRxRate = 13; optional string domainId = 14; optional string tenantId = 15; optional string switchGroupLevelOneId = 16; optional string switchGroupLevelTwoId = 17; optional string switchId = 18; optional string domainName = 19; optional string switchGroupLevelOneName = 20; optional string switchGroupLevelTwoName = 21; optional string switchUnitId = 22; } message SwitchGroup { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string domainId = 2; optional string creatorId = 3; optional string tenantId = 4; optional string switchGroupLevelOneId = 5; optional string switchGroupLevelTwoId = 6; optional uint64 createDatetime = 7; optional string name = 8; optional string description = 9; optional string firmware = 10; } message GpbNetworkPort { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; option (com.ruckuswireless.scg.protobuf.storage.category) = DEVICE; optional string portMac = 1; optional string switchSerialNum = 2; optional string switchUnitId = 3; optional PortConfig portConfig = 4; optional PortStatus portStatus = 5; optional string portId = 6 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; // portMac_portIdentifier } message PortConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = CONFIG; optional string portMac = 1; optional string switchId = 2; optional string switchUnitId = 3; optional string portId = 4 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; } message PortStatus { optional string portMac = 1; optional string switchId = 2; optional string type = 3; optional string name = 4; optional string status = 5; optional string adminStatus = 6; optional string vlanIds = 7; optional string neighborName = 8; optional string portSpeed = 9; optional bool ruckusDevice = 10; optional bool lldpEnabled = 11; optional string lagName = 12; optional string lagStatus = 13; optional string spanningTreeStatus = 14; optional int32 poeUsed = 15; optional int32 poeTotal = 16; optional double poePercent = 17; optional string domainId = 18; optional string switchGroupLevelOneId = 19; optional int64 tx = 20; optional int64 rx = 21; optional double signalIn = 22; optional double signalOut = 23; optional int64 crcErr = 24; optional int64 inErr = 25; optional int64 outErr = 26; optional string opticsType = 27; optional string tenantId = 29; optional string switchGroupLevelTwoId = 30; optional string portSpeedCapacity = 31; optional string switchUnitId = 32; optional string portIfaceName = 33; optional bool poeEnabled = 34; optional bool usedInFormingStack = 35; optional string portIdentifier = 36; optional string unTaggedVlan = 37; optional bool isInWarningState = 38; optional int64 inDiscard = 39; optional int64 broadcastIn = 40; optional int64 broadcastOut = 41; optional int64 multicastIn = 42; optional int64 multicastOut = 43; optional string poeType = 44; optional string portIdentifierFormatted = 45; optional string portId = 46 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string domainName = 47; optional string switchGroupLevelOneName = 48; optional string switchGroupLevelTwoName = 49; optional int64 unicastOut = 50 [(com.ruckuswireless.scg.protobuf.storage.ingest) = "delta"]; optional int64 unicastIn = 51 [(com.ruckuswireless.scg.protobuf.storage.ingest) = "delta"]; optional string vlanDetailInformation = 52; optional string switchName = 53; optional string neighborMacAddress = 54; optional string inAclConfigName = 55; optional string outAclConfigName = 56; optional int32 poeClass = 57; optional int32 poePriority = 58; optional int32 poeBudget = 59; optional int32 lagId = 60; optional string lagAdminStatus = 61; optional string searchableVlans = 62; optional PortType resourceName = 63; optional bool isLagMember = 64;
6.1.1 update
optional string poePdClass = 65; optional string poePdClassB = 66; optional string poeLldpMaxPowerRequest = 67; optional string poeLldpMaxPowerRequestA = 68; optional string poeLldpMaxPowerRequestB = 69; optional PoePortCapability poePortCapability = 70; optional string poe2PairMaxPower = 71; optional string poe4PairMaxPower = 72; optional PoeOverDriveMode poeOverdriveMode = 73; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated GpbNetworkPort ports = 1000; } message Client { option (com.ruckuswireless.scg.protobuf.storage.category) = STATUS; optional string mac = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string switchSerialNum = 2; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated GpbNetworkSwitch switches = 1001; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated SwitchGroup switchGroups = 1002; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated RegistrationRule registrationRules = 1003; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated FanGroup fanGroups = 1004; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated TempThresholdGroup tempThresholdGroups = 1005; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated PowerSupplyGroup powerSupplyGroups = 1006; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated GpbSwitchUnit switchUnits = 1007; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated Job jobs = 1008; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated GpbConnectedDevice connectedDevices = 1009; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated SwitchCredential switchCredentials = 1010; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated ConfigBackup configBackups = 1011; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated Schedule schedules = 1012; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated SystemConfig systemConfigs = 1013; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated GroupModelConfig groupModelConfigs = 1014; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated VlanConfig vlanConfigs = 1015; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated AaaServer aaaServers = 1016; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated DeployLog deployLogs = 1017; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated DeployLogItem deployLogItems = 1018; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated SwitchConfigStore switchConfigStores = 1019; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated CommonSettings commonSettings = 1020; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated StaticRoute staticRoutes = 1021; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated ACLConfig aclConfigs = 1022; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated SpecificSettings specificSettings = 1023; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated PortConfiguration portConfiguration = 1024; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated VEConfig veConfigs = 1025; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated LAGConfig lagConfigs = 1027; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated StackConfig stackConfigs = 1028; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated VlanPortRelation vlanPortRelations = 1029; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated DeploySchedule deploySchedules = 1030; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated DeployPending deployPendings = 1031; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated SwitchClientVisibility switchClientVisibilities = 1032; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated SupportSaveStatus supportSaveStatus = 1033; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated KumoSwitch kumoSwitch = 1034; } extend com.ruckuswireless.scg.protobuf.storage.ListModel { repeated AAASetting aaaSetting = 1035; } message Job { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string type = 2; optional string action = 3; optional string status = 4; optional string failureReason = 5; optional string switchId = 6; optional string domainId = 7; optional string tenantId = 8; optional string switchGroupLevelOneId = 9; optional string switchGroupLevelTwoId = 10; optional int64 createdTimestamp = 11; optional int64 modifiedTimestamp = 12; optional string csvData = 13; optional string stickyNodeId = 14; optional string scheduleId = 15; optional int32 retryCount = 16; } message Schedule { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string type = 2; optional string triggerValue = 3; optional int64 createdTimestamp = 4; optional string switchId = 5; optional string jobType = 6; optional string jobAction = 7; optional string csvData = 8; optional string stickyNodeId = 9; optional string status = 10; } enum RegistrationRuleType { IP_RANGE = 1; SUBNET = 2; MODEL_NUMBER = 3; } message RegistrationRule { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; // No suitable category, set the category to GROUP for now. option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string creatorId = 2; optional string switchGroupId = 3; optional RegistrationRuleType type = 4; optional string ipFrom = 5; optional string ipTo = 6; optional string network = 7; optional string subnetMask = 8; optional string modelNumber = 9; optional int32 rank = 10; optional uint64 createDatetime = 11; optional string description = 12; } message GpbSwitchUnit { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; option (com.ruckuswireless.scg.protobuf.storage.category) = DEVICE; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional SwitchUnitConfig switchUnitConfig = 2; optional SwitchUnitStatus switchUnitStatus = 3; } message SwitchUnitConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = CONFIG; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; //Switch-Unit serial number optional string switchId = 2; //Reference key for Switch/Stack optional string model = 3; optional string macAddress = 4; optional int32 numOfPorts = 5; optional string modules = 6; optional string unitName = 7; optional string unitSlNum = 8; optional string portStatusUp = 9; optional string portStatusWarning = 10; optional string portStatusDown = 11; } message SwitchUnitStatus { optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; //Switch-Unit serial number optional string switchId = 2; optional string upTime = 3; optional string unitStatus = 4; //Active Or Passive optional string unitSlNum = 8; optional string domainId = 9; optional string switchGroupLevelOneId = 10; optional string switchGroupLevelTwoId = 11; optional string domainName = 12; optional string switchGroupLevelOneName = 13; optional string switchGroupLevelTwoName = 14; optional int32 unitId = 15; optional string unitState = 16; optional string unitName = 17; optional int32 poeUtilization = 18; optional int32 poeTotal = 19; optional int32 poeFree = 20; } message GpbConnectedDevice { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; option (com.ruckuswireless.scg.protobuf.storage.category) = DEVICE; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; //Remote Port MAC optional ConnectedDeviceConfig connectedDeviceConfig = 2; optional ConnectedDeviceStatus connectedDeviceStatus = 3; } message ConnectedDeviceConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = CONFIG; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; //Remote Port MAC optional string remotePortMac = 2; //Remote Port MAC optional string localPortMac = 3; optional string switchId = 4; optional string remoteDeviceMac = 5; } message ConnectedDeviceStatus { option (com.ruckuswireless.scg.protobuf.storage.category) = STATUS; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; //Remote Port MAC optional string remotePortMac = 2; optional string remoteDeviceName = 3; optional string remotePortType = 4; optional string remotePortDesc = 5; optional string localPort = 6; optional string remotePort = 7; optional string isRuckusAP = 8; optional string domainId = 9; optional string tenantId = 10; optional string switchGroupLevelOneId = 11; optional string switchGroupLevelTwoId = 12; optional string switchId = 13; optional string unitId = 14; optional string localPortIfaceName = 15; optional string localPortMac = 16; optional string domainName = 17; optional string switchGroupLevelOneName = 18; optional string switchGroupLevelTwoName = 19; optional int64 updatedTime = 20; optional string remoteDeviceMac = 21; } message LAGStatus { option (com.ruckuswireless.scg.protobuf.storage.category) = STATUS; optional string lagName = 1; optional int32 lagId = 2; optional string lagStatus = 3; optional string lagAdminStatus = 4; optional string vlanIds = 5; optional string switchId = 6; optional string unTaggedVlan = 7; optional string switchUnitId = 8; optional string domainName = 9; optional string switchGroupLevelOneName = 10; optional PortType resourceName = 11; optional bool isLagMember = 12; } enum SwitchCredentialSNMPType { SNMP_V2 = 1; SNMP_V3 = 2; } enum SwitchCredentialAuthProtocolType { SHA = 1; MD5 = 2; } enum SwitchCredentialPrivacyProtocolType { PROTO_NONE = 1; AES = 2; DES = 3; } message SwitchCredential { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string creatorName = 2; optional SwitchCredentialSNMPType type = 3; optional string description = 4; optional string community = 5; optional string userName = 6; optional string authPassword = 7; optional SwitchCredentialAuthProtocolType authProtocol = 8; optional string privacyPassword = 9; optional SwitchCredentialPrivacyProtocolType privacyProtocol = 10; optional int32 rank = 11; optional uint64 createDatetime = 12; } message ConfigBackup { option (com.ruckuswireless.scg.protobuf.storage.entity) = true; option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; enum BackupType { MANUAL = 1; SCHEDULED = 2; } optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string name = 2; optional int64 backupStartTime = 3; optional int64 backupEndTime = 4; optional int64 lastRestoreStartTime = 5; optional int64 lastRestoreEndTime = 6; optional BackupType type = 7; optional string switchId = 8; optional string config = 9; optional string backupStatus = 10; optional string lastRestoreStatus = 11; optional string domainId = 12; optional string switchGroupLevelOneId = 13; optional string switchGroupLevelTwoId = 14; optional string failureReason = 15; optional int64 backupStartTriggerTime = 16; optional int64 restoreStartTriggerTime = 17; optional int32 retryCount = 18; } message SystemConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = DATA; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string scepEnrollments = 2; optional string eventConfig = 3; optional string switchTrackConfig = 4; optional string aaaSettings = 5; optional int64 postUpgradeTime = 6; } message GroupModelConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string familyId = 2; optional string groupId = 3; optional int64 createdTime = 4; optional int64 updatedTime = 5; optional bool hasVlanConfig = 6; optional bool hasAclConfig = 7; optional bool hasStaticRouteConfig = 8; optional bool hasConfigured = 9; optional bool hasSelected = 10; } message VlanConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional int32 vlanId = 2; optional string name = 3; optional string groupId = 4; optional string familyId = 5; optional string switchId = 6; optional bool enableIpv4DhcpSnooping = 7; optional string ipv4DhcpSnoopingTrustPort = 8; optional bool enableArpInspection = 9; optional string arpInspectionTrustPort = 10; optional IgmpSnoopingType igmpSnooping = 11; optional string multicastVersion = 12; optional SpanningTreeType spanningTree = 13; optional int32 spanningTreePriority = 14; optional string portsConfig = 15; optional PushTimeType pushTimeType = 16; optional int64 pushTime = 17; optional int64 createdTime = 18; optional int64 updatedTime = 19; optional string arpInspectionsConfig = 20; optional int64 scheduled = 21; optional bool initialConfig = 22; optional string rootBridgeFamilyId = 23; } enum Level { READ_WRITE = 1; PORT_CONFIG = 2; READ_ONLY = 3; LEVEL_NONE = 4; } enum ServerType { RADIUS = 1; TACACS_PLUS = 2; LOCAL = 3; SERVER_TYPE_NONE = 4; } message AAASetting { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional bool authnEnabledSSH = 2; optional bool authnEnableTelnet = 3; optional ServerType authnFirstPref = 4 [default = SERVER_TYPE_NONE]; optional ServerType authnSecondPref = 5 [default = SERVER_TYPE_NONE]; optional ServerType authnThirdPref = 6 [default = SERVER_TYPE_NONE]; optional bool authzEnabledCommand = 7; optional bool authzEnabledExec = 8; optional Level authzCommonsLevel = 9 [default = LEVEL_NONE]; optional ServerType authzCommonsServer1 = 10 [default = SERVER_TYPE_NONE]; optional ServerType authzCommonsServer2 = 11 [default = SERVER_TYPE_NONE]; optional ServerType authzExecServer1 = 12 [default = SERVER_TYPE_NONE]; optional ServerType authzExecServer2 = 13 [default = SERVER_TYPE_NONE]; optional bool acctEnabledCommand = 14; optional bool acctEnabledExec = 15; optional Level acctCommonsLevel = 16 [default = LEVEL_NONE]; optional ServerType acctCommonsServer1 = 17 [default = SERVER_TYPE_NONE]; optional ServerType acctCommonsServer2 = 18 [default = SERVER_TYPE_NONE]; optional ServerType acctExecServer1 = 19 [default = SERVER_TYPE_NONE]; optional ServerType acctExecServer2 = 20 [default = SERVER_TYPE_NONE]; optional int64 updatedTime = 21; } message AaaServer { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; /** * @internal **/ enum Purpose { DEFAULT = 1; AUTHENTICATION_ONLY = 2; AUTHORIZATION_ONLY = 3; ACCOUNTING_ONLY = 4; } optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string name = 2; optional int64 createdTime = 3; optional int64 updatedTime = 4; optional ServerType serverType = 5; // radius and tacacs optional string ip = 6; optional int32 authPort = 7; optional int32 acctPort = 8; optional string secret = 9; // tacacs optional Purpose purpose = 10; // local user optional string username = 11; optional string password = 12; optional Level level = 13; // creator & updater optional string creatorUsername = 14; optional string creatorId = 15; optional string updaterUsername = 16; optional string updaterId = 17; optional string groupId = 18; } enum DeployScope { PRE_PROVISION = 1; PROVISION = 2; GROUP = 3; PORT = 4; SWITCH = 5; COPY = 6; OVERWRITE = 7; } enum ConfigFeature { VLAN = 1; ACL = 2; STATIC_ROUTE = 3; } enum ConfigType { PROVISIONING = 1; GLOBAL = 2; COMMON = 3; MODEL = 4; SWITCH_SETTINGS = 5; PORT_SETTINGS = 6; COPY_CONFIGS = 7; LAG_SETTINGS = 8; IP_PORTS = 9; VE_PORTS = 10; PORT_CONFIGURATION = 11; OVERWRITE_CONFIGURATION = 12; STACK = 13; AAA_SETTING = 14; AAA_SERVER = 15; } message DeployLog { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; enum DeployStatus { PENDING = 1; STARTED = 2; SUCCESS = 3; FAILURE = 4; } optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string transactionId = 2; optional string groupId = 3; optional string modelFamily = 4; optional string yang = 5; optional ConfigType configType = 6; optional DeployScope deployScope = 7; optional DeployStatus deployStatus = 8; optional string switchIds = 9; optional int64 scheduled = 10; optional int64 startTime = 11; optional int64 endTime = 12; optional ConfigFeature configFeature = 13; optional int32 success = 14; optional int32 failed = 15; optional int32 failedNoResponse = 16; optional int32 failedSaveFlash = 17; optional string nodeId = 18; } message DeployLogItem { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; /** * @internal **/ enum DispatchStatus { PENDING = 1; IN_PROGRESS = 2; SUCCESS = 3; FAILED = 4; PENDING_LOCAL_SYNC = 5; FAILED_NO_RESPONSE = 6; FAILED_SAVE_FLASH = 7; NO_CONFIG_CHANGE = 8; OFFLINE = 9; ROAMED = 10; } optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string transactionId = 2; optional string switchId = 3; optional string yang = 4; optional string clis = 5; optional DispatchStatus dispatchStatus = 6; optional string dispatchError = 7; optional int64 startTime = 8; optional int64 endTime = 9; optional string removeYang = 10; optional string nodeId = 11; } message SwitchConfigStore { option (com.ruckuswireless.scg.protobuf.storage.category) = CONFIG; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string yang = 2; optional string backup = 3; optional int64 lastConfigTime = 4; optional int64 lastSwitchConfigTime = 5; optional int64 lastStartupSwitchConfigTime = 6; optional bool localSyncCompleted = 7; } message CommonSettings { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional int64 updatedTime = 2; optional int64 createdTime = 3; optional string dnsConfig = 4; } message CommonSettingsDns { optional string ip = 1; } message StaticRoute { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string groupId = 2; optional string familyId = 3; optional string destinationIp = 4; optional string nextHop = 5; optional int64 adminDistance = 6; optional PushTimeType pushTimeType = 7; optional int64 pushTime = 8; optional int64 createdTime = 9; optional int64 updatedTime = 10; optional string switchId = 11; optional int64 scheduled = 12; optional bool initialConfig = 13; } message ACLConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string groupId = 2; optional string familyId = 3; optional string switchId = 4; optional string name = 5; optional ACLType aclType = 6; optional string ruleConfig = 7; optional PushTimeType pushTimeType = 8; optional int64 pushTime = 9; optional int64 createdTime = 10; optional int64 updatedTime = 11; optional int64 scheduled = 12; } enum ACLType { STANDARD = 1; EXTENDED = 2; } message ACLRule { optional int32 seq = 1; optional ACLRuleAction action = 2; optional ACLRuleProtocol protocol = 3; optional string srcNetwork = 4; optional string destNetwork = 5; optional int32 srcPort = 6; optional int32 destPort = 7; } enum ACLRuleAction { PERMIT = 1; DENY = 2; } enum ACLRuleProtocol { IP = 1; TCP = 2; UDP = 3; } enum PushTimeType { NOW = 1; SCHEDULE = 2; } message StackConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional int64 createdTime = 2; optional int64 updatedTime = 3; optional string switchId = 4; optional bool isActiveRole = 5; optional string activeSwitchId = 6; optional int32 suggestedId = 7; optional StackDeployState stackDeployState = 8; enum StackDeployState { INIT = 1; FAILURE = 2; SUCCESS = 3; } } message SpecificSettings { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string hostname = 2; optional IgmpSnoopingType igmpSnooping = 3; optional bool jumboMode = 4; optional bool dhcpServerEnabled = 5; optional bool enabledAclPerPortPerVlan = 6; optional string dhcpServerSetting = 7; optional int64 createdTime = 8; optional int64 updatedTime = 9; optional string groupId = 10; optional string ipv4DhcpSnoopingTrustPort = 11; optional string arpInspectionTrustPort = 12; } message DHCPServer { optional string poolName = 1; optional string network = 2; optional string excludedStart = 3; optional string excludedEnd = 4; optional int32 leaseDays = 5; optional int32 leaseHrs = 6; optional int32 leaseMins = 7; optional string defaultRouterIp = 8; repeated DHCPOption dhcpOptions = 9; } message DHCPOption { optional int32 seq = 1; optional DHCPOptionType type = 2; optional string value = 3; enum DHCPOptionType { ASCII = 1; HEX = 2; IP = 3; } } enum IgmpSnoopingType { IST_NONE = 1; ACTIVE = 2; PASSIVE = 3; } message PortConfiguration { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string groupId = 2; optional string switchId = 3; optional string port = 4; optional string portName = 5; optional bool portEnabled = 6; optional string taggedVlans = 7; optional string untaggedVlans = 8; optional bool poeEnabled = 9; optional POEClass poeClass = 10; optional int32 poePriority = 11; optional PortSpeed portSpeed = 13; optional bool rstpAdminEdgePortEnabled = 14; optional bool stpBpduGuardEnabled = 15; optional bool stpRootGuardEnabled = 16; optional bool dhcpSnoopingTrustPortEnabled = 17; optional bool ipsgEnabled = 18; optional bool lldpEnabled = 19; optional string inAclConfigUUID = 20; optional string inAclConfigName = 21; optional string outAclConfigUUID = 22; optional string outAclConfigName = 23; optional string dhcpRelayAgent = 24; optional string ipAddress = 25; optional string ospfArea = 26; optional string subnetMask = 27; optional int64 createdTime = 28; optional int64 updatedTime = 29; optional string portIdentifierFormatted = 30; optional bool hasLayerThreeConfig = 31; optional bool poeCapability = 32; enum POEClass{ ZERO = 1; ONE = 2; TWO = 3; THREE = 4; FOUR = 5; FIVE = 6; } enum PortSpeed { NONE = 1; AUTO = 2; TEN_M_FULL = 3; TEN_M_HALF = 4; ONE_HUNDRED_M_FULL = 5; ONE_HUNDRED_M_HALF = 6; ONE_G_FULL = 7; ONE_G_FULL_MASTER = 8; ONE_G_FULL_SLAVE = 9; TWO_POINT_FIVE_G_FULL = 10; TWO_POINT_FIVE_G_FULL_MASTER = 11; TWO_POINT_FIVE_G_FULL_SLAVE = 12; FIVE_G_FULL = 13; FIVE_G_FULL_MASTER = 14; FIVE_G_FULL_SLAVE = 15; TEN_G_FULL = 16; TEN_G_FULL_MASTER = 17; TEN_G_FULL_SLAVE = 18; TWENTY_FIVE_G_FULL = 19; FORTY_G_FULL = 20; ONE_HUNDRED_G_FULL = 21; } } enum SpanningTreeType { STT_NONE = 1; STP = 2; RSTP = 3; } message VEConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string name = 2; optional string groupId = 3; optional string switchId = 4; optional string ospfArea = 5; optional int32 vlanId = 6; optional string dhcpRelayAgent = 7; optional string ipAddress = 8; optional string subnetMask = 9; optional string inAclConfigUUID = 10; optional string inAclConfigName = 11; optional string outAclConfigUUID = 12; optional string outAclConfigName = 13; optional int32 veId = 14; optional int64 createdTime = 15; optional int64 updatedTime = 16; optional bool initialConfig = 17; } message LAGConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string switchId = 2; optional string groupId = 3; optional string name = 4; optional string portsConfig = 5; optional LAGType type = 6; optional int64 createdTime = 7; optional int64 updatedTime = 8; optional string lastName = 9; /** * @internal **/ enum LAGType { STATIC = 1; DYNAMIC = 2; } } message VlanPortRelation { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string groupId = 2; optional string switchId = 3; optional RelationType relationType = 4; optional string port = 5; optional int32 vlanId = 6; /** * @internal **/ enum RelationType{ TAGGED = 1; UNTAGGED = 2; } } message DeploySchedule { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional int64 scheduled = 2; optional int64 createdTime = 3; optional int64 pickedTime = 4; optional string transactionId = 5; optional string entityId = 6; optional string groupId = 7; optional string switchId = 8; optional string modelFamily = 9; optional ConfigType configType = 10; optional DeployScope deployScope = 11; optional ConfigFeature configFeature = 12; optional string config = 13; optional string switchIds = 14; optional string works = 15; optional string nodeId = 16; } message DeployPending { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional int64 createdTime = 2; optional string switchId = 3; optional ConfigType configType = 4; optional ConfigFeature configFeature = 5; optional string globalTypes = 6; optional string config = 7; optional string nodeId = 8; } message SwitchClientStatus { /** * @property snapshot * @aggregation NULL * @description List of Switch Client Visibility * @since 5.1.2.1 */ repeated SwitchClientVisibility switchClientVisibilities = 1; /** * @property snapshot * @aggregation NULL * @description Number of Switch Client Visibility * @since 5.1.2.1 */ optional int32 switchClientVisibilityCount = 2; /** * @property snapshot * @aggregation NULL * @description Domain identifier of SZ. * @since 5.1.2.1 */ optional string domainId = 3; /** * @property snapshot * @aggregation NULL * @description Identifier of switch. * @since 5.1.2.1 */ optional string switchId = 4; } message SwitchClientVisibility { option (com.ruckuswireless.scg.protobuf.storage.category) = INFORMATION; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; //SwitchId + SwitchPortId + ClientMAC + VLAN optional string domainId = 2; optional string tenantId = 3; optional string switchId = 4; optional string groupId = 5; optional string unitId = 6; optional string switchPortId = 7; optional string domainName = 8; optional string switchName = 9; optional string switchPort = 10; optional string clientMac = 11; optional string clientVlan = 12; optional ClientType clientType = 13; optional ClientAuthType clientAuthType = 14; optional ClientAuthStatus clientAuthStatus = 15; optional string clientDesc = 16; optional string clientUserName = 17; optional string clientIpv4Addr = 18; optional string clientIpv6Addr = 19; optional string clientUpTime = 20; optional string pastAuthHistory = 21; optional int64 createdTime = 22; optional int64 updatedTime = 23; optional string vlanName = 24; optional int64 historyExpirationTime = 25; optional string switchGroupLevelOneId = 26; optional string switchGroupLevelTwoId = 27; optional string switchGroupLevelOneName = 28; optional string switchGroupLevelTwoName = 29; optional bool isRuckusAP = 30; optional string clientName = 31; optional string dot1XIpv4Addr = 32; optional string dot1XIpv6Addr = 33;
6.1.1 update
optional string clientVni = 34; } enum ClientType { OTHER = 1; PHONE = 2; WLAN_AP = 3; ROUTER = 4; BRIDGE = 5; CABLE_DEVICE = 6; } enum ClientAuthType { CLIENT_AUTH_TYPE_NONE = 1; DOT1X = 2; MAC_AUTH = 3; WEB_AUTH = 4; } enum ClientAuthStatus { NO_AUTH = 1; ALLOWED = 2; BLOCKED = 3; RESTRICTED = 4; CRITICAL = 5; GUEST = 6; } message SwitchConfigurationMessage { optional SwitchClusterMessage clusterInfo = 1; optional uint64 timestamp = 2; } message SwitchClusterMessage { optional string clusterUuid = 1; optional string clusterName = 2; repeated TenantMessage tenantInfos = 3; } message TenantMessage { optional string tenantId = 1; optional string tenantName = 2; optional DomainMessage adminDomain = 3; } message DomainMessage { optional string domainId = 1; optional string domainName = 2; repeated DomainMessage subDomainInfos = 3; repeated SwitchGroupMessage switchGroupInfos = 4; } message SwitchGroupMessage { optional string switchGroupId = 1; optional string switchGroupName = 2; repeated SwitchGroupMessage subSwitchGroupInfos = 3; } message RealtimeSwitchStatus { optional string serialNumber = 1; optional string switchMac = 2; optional string domainId = 3; optional string domainName = 4; optional string switchGroupLevelOneId = 5; optional string switchGroupLevelOneName = 6; optional string switchGroupLevelTwoId = 7; optional string switchGroupLevelTwoName = 8; optional string status = 9; optional bool operational = 10; optional bool firmwareUpgrading = 11; optional string ipAddress = 12; optional string subnetMask = 13; optional string defaultGateway = 14; optional string staticOrDynamic = 15; optional string dns = 16; optional string firmwareVersion = 17; optional bool collectorExecuted = 18; } message SupportSaveStatus { option (com.ruckuswireless.scg.protobuf.storage.category) = GROUP; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string serialNumber = 2; optional string switchId = 3; optional string scpIp = 4; optional int32 scpPort = 5; optional string userName = 6; optional string password = 7; optional string pathToSave = 8; optional DownloadStatus downloadStatus = 9; optional string createdTime = 10; enum DownloadStatus{ DOWNLOADING = 1; DONE = 2; TIMEOUT = 3; FAILED = 4; } } message KumoSwitch { option (com.ruckuswireless.scg.protobuf.storage.category) = CONFIG; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string initialCli = 2; optional string portConfiguration = 3; optional string serialNumber = 4; optional string featureConfigs = 5; } message RelayExternalSyslogConfig { option (com.ruckuswireless.scg.protobuf.storage.category) = CONFIG; optional string id = 1 [(com.ruckuswireless.scg.protobuf.storage.id) = true]; optional string ip = 2; optional int32 port = 3; optional string protocol = 4; } message SwitchDetail { optional string id = 1; optional string switchName = 2; optional string macAddress = 3; optional string model = 4; optional string family = 5; optional string ipAddress = 6; optional string registrationStatus = 7; optional int32 numOfPorts = 8; optional string serialNumber = 9; optional string groupName = 10; optional string groupId = 11; optional string status = 12; optional string firmwareVersion = 14; optional bool isStack = 15; optional uint64 numOfUnits = 16; optional string szNodeAttached = 17; optional bool operational = 18; } message SwitchDetailMessage { repeated SwitchDetail switchDetail = 1; } message unitSlNum { required string id = 1; optional string remotePortMac = 2; optional string remoteDeviceName = 3; optional string remotePortType = 4; optional string remotePortDesc = 5; optional string localPort = 6; optional string remotePort = 7; optional string isRuckusAP = 8; optional string domainId = 9; optional string tenantId = 10; optional string switchGroupLevelOneId = 11; optional string switchGroupLevelTwoId = 12; optional string switchId = 13; optional string unitId = 14; optional string localPortIfaceName = 15; optional string localPortMac = 16; }

Field Description

Power Supply Group Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
id string snapshot NULL Identifier of switch.
stackId string snapshot NULL Stack identifier of switch.
powerSlotNum int32 snapshot NULL Power Supply Slot Number of switch.
powerSupplyType string snapshot NULL Power Supply Type of switch.
powerSupplyStatus string snapshot NULL Power Supply Status of switch.
serialNumber string snapshot NULL Serial Number of switch.

Fan Group Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
id string snapshot NULL Identifier of switch.
stackId string snapshot NULL Stack identifier of switch.
slotNum int32 snapshot NULL Fan Slot Number of switch.
type string snapshot NULL Fan Type of switch.
status string snapshot NULL Fan Status of switch.
serialNumber string snapshot NULL Serial Number of switch.

Switch Status Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
id string snapshot NULL Identifier of switch.
firmware string snapshot NULL Firmware version of switch.
model string snapshot NULL Model of switch.
defaultGateway string snapshot NULL Default gateway of switch.
numOfPorts int32 snapshot NULL Number of switch ports.
natIp string snapshot NULL NAT IP of switch.
status string snapshot NULL Status of switch
poeAvailable bool snapshot NULL PoE support of switch.
lastBackup uint64 snapshot NULL Last backup of switch.
cpu uint64 snapshot NULL CPU utilization of switch.
memory uint64 snapshot NULL Memory utilization of switch.
uptime string snapshot NULL Uptime of switch.
alerts int32 snapshot NULL Alerts of switch.
isStack bool snapshot NULL Stack support of switch.
stackId string snapshot NULL Stack identifier of switch.
priority int32 snapshot NULL Priority.
modules string snapshot NULL Modules of switch.
domainId string snapshot NULL Domain identifier of SZ.
groupId string snapshot NULL Group identifier of switch.
lastUpdateTimeInMillis uint64 snapshot NULL Last update time in millis.
switchName string snapshot NULL Name of switch.
tenantId string snapshot NULL Tenant identifier of SZ.
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch group.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch group.
serialNumber string snapshot NULL Serial number of switch.
unitSerialNumbers string snapshot NULL Serial numbers of switch unit.
portModuleIds string snapshot NULL Port module identifiers of switch.
partitionInUse string snapshot NULL Partition in use.
switchMode string snapshot NULL Mode of switch.
switchSWVersion string snapshot NULL Software version of switch.
numOfUnits int32 snapshot NULL Number of switch units.
poeUtilization int32 snapshot NULL PoE allocated capacity of switch.
poeTotal int32 snapshot NULL Total PoE capacity of switch.
poeFree int32 snapshot NULL PoE unallocated capacity of switch.
family string snapshot NULL Family of switch.
cloudPort string cloudPort NULL Cloud port(uplink port) of switch for Alto.
domainName string snapshot NULL Domain name of SZ.
switchGroupLevelOneName string snapshot NULL Level 1 Group name of switch.
switchGroupLevelTwoName string snapshot NULL Level 2 Group name of switch.
powerSupplyGroups string snapshot NULL Power Supply Group status of switch.
fanGroups string snapshot NULL Fan Group status of switch.
ipAddress string snapshot NULL Switch IP.
subnetMask string snapshot NULL Switch subnetmask.
staticOrDynamic string snapshot NULL Switch default gateway.
dns string snapshot NULL Switch DNS settings.PortStatus
temperatureGroups string snapshot NULL Temperature Group status of switch.
totalMemory uint64 snapshot NULL Total memory.
freeMemory uint64 snapshot NULL Free memory.
hasPoECapability BOOL snapshot NULL Has PoE capability.
operational BOOL snapshot NULL operational
reservedField1        
reservedField2        
reservedField3        
reservedField4        
6.1.1 update
localsyncStatus
.com.ruckuswireless.scg.protobuf.icx.LocalSyncRunningStatus snapshot NULL localsyncStatus.poePdClass.

Switch Stats Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

id string snapshot NULL Switch identifier
timestamp int64 snapshot NULL Timestamp.
switchSerialNum string snapshot NULL Serial number of switch.
tx int64 snapshot SUM TX bytes of switch.
rx int64 snapshot SUM RX bytes of switch.
txRx int64 snapshot SUM TX/RX bytes of switch.
txPkt int64 snapshot SUM TX packets of switch.
rxPkt int64 snapshot SUM RX packets of switch.
txRxPkt int64 snapshot SUM TX/RX packets of switch.
txRate int64 snapshot SUM TX bit rate of switch (in kilobits per second, within a five-minute interval.).
rxRate int64 snapshot SUM RX bit rate of switch (in kilobits per second, within a five-minute interval.).
txRxRate int64 snapshot SUM TX/RX bit rate of switch (in kilobits per second, within a five-minute interval.).
cpu int64 snapshot NULL CPU utilization of switch.
memory int64 snapshot NULL Memory utilization of switch.
domainId string snapshot NULL Domain identifier of SZ.
tenantId string snapshot NULL Tenant identifier of SZ.
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch group.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch group.
domainName string snapshot NULL Domain name of SZ.
switchGroupLevelOneName string snapshot NULL Level 1 Group name of switch group.
switchGroupLevelTwoName string snapshot NULL Level 2 Group name of switch group.
multicastOut int64 snapshot SUM MulticastOut
multicastIn int64 snapshot SUM MulticastIn
broadcastOut int64 snapshot SUM BroadcastOut
broadcastIn int64 snapshot SUM broadcastIn
crcErr int64 snapshot SUM CrcErr
outErr int64 snapshot SUM OutErr
inErr int64 snapshot SUM InErr
unicastOut int64 snapshot SUM UunicastOut
unicastIn int64 snapshot SUM UnicastIn
collectorExecuted bool snapshot NULL Switch collector executed

Port Stats Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

id string snapshot NULL Port identifier
timestamp int64 snapshot NULL Timestamp.
switchSerialNum string snapshot NULL Serial number of switch.
portMac string snapshot NULL Mac address of port.
tx int64 snapshot SUM TX bytes of port.
rx int64 snapshot SUM RX bytes of port
txRx int64 snapshot SUM TX/RX bytes of port.
txPkt int64 snapshot SUM TX packets of port.
rxPkt int64 snapshot SUM RX packets of port.
txRxPkt int64 snapshot SUM TX/RX packets of port.
txRate int64 snapshot SUM TX bit rate of port (in kilobits per second, within a five-minute interval.).
rxRate int64 snapshot SUM RX bit rate of port (in kilobits per second, within a five-minute interval.).
txRxRate int64 snapshot SUM TX/RX bit rate of port (in kilobits per second, within a five-minute interval.).
domainId string snapshot NULL Domain identifier of SZ.
tenantId string snapshot NULL Tenant identifier of SZ.
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch group.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch group.
switchId string snapshot NULL Identifier of switch.
domainName string snapshot NULL Domain name of SZ.
switchGroupLevelOneName string snapshot NULL Level 1 Group name of switch.
switchGroupLevelTwoName string snapshot NULL Level 2 Group name of switch.
switchUnitId string snapshot NULL Identifier of switch unit.

Port Status Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

portMac string snapshot NULL Mac address of port.
switchId string snapshot NULL Identifier of switch.
type string snapshot NULL Type of port.
name string snapshot NULL Name of port.
status string snapshot NULL Status of port.
adminStatus string snapshot NULL Admin status of port.
vlanIds string snapshot NULL VLAN identifier of port.
neighborName string snapshot NULL Neighbor name of port.
portSpeed string snapshot NULL Speed of port.
ruckusDevice bool snapshot NULL Ruckus devices support of port.
lldpEnabled bool snapshot NULL LLDP enabled flag of port.
lagName string snapshot NULL LAG name of port.
lagStatus string snapshot NULL LAG status of port.
spanningTreeStatus string snapshot NULL Spanning tree status of port.
poeUsed int32 snapshot NULL Amount of inline power consumed by the port. Each unit is in milliwatts.
poeTotal int32 snapshot NULL Adjusts the inline power wattage. Valid values are from 1000 through 15400(IEEE802_3AF)/30000(IEEE802_3AT). Each unit is in milliwatts.
poePercent double snapshot AVG Percentage of inline power consumed by the port.
domainId string snapshot NULL Domain identifier of SZ.
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch group.
tx int64 snapshot SUM TX bytes of port.
rx int64 snapshot SUM RX bytes of port.
signalIn double snapshot AVG Input network utilization in hundredths of a percent over a five-minute interval.
signalOut double snapshot AVG Output network utilization in hundredths of a percent over a five-minute interval.
crcErr int64 snapshot NULL Stats CRC align errors of port.
inErr int64 snapshot NULL Input errors of port.
outErr int64 snapshot NULL Output errors of port.
opticsType string snapshot NULL Optics type of port.
tenantId string snapshot NULL Tenant identifier of SZ.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch group.
portSpeedCapacity string snapshot NULL Capacity of port speed.
switchUnitId string snapshot NULL Identifier of switch unit.
portIfaceName string snapshot NULL Interface name of port.
poeEnabled bool snapshot NULL PoE enabled flag of port.
usedInFormingStack bool snapshot NULL "Used in forming stack" flag of port.
portIdentifier string snapshot NULL Description of port.
unTaggedVlan string snapshot NULL Untagged VLAN of port.
isInWarningState bool snapshot NULL "Is in warning state" flag of port.
inDiscard int64 snapshot NULL Input discards of port.
broadcastIn int64 snapshot SUM Input broadcast packets of port.
broadcastOut int64 snapshot SUM Output broadcast packets of port.
multicastIn int64 snapshot SUM Input multicast packets of port.
multicastOut int64 snapshot SUM Output multicast packets of port.
poeType string snapshot NULL PoE type of port.
portIdentifierFormatted string snapshot NULL Formatted of port identifier.
portId string snapshot NULL Port identifier.
domainName string snapshot NULL Domain name of SZ.
switchGroupLevelOneName string snapshot NULL Level 1 Group name of switch.
switchGroupLevelTwoName string snapshot NULL Level 2 Group name of switch.
unicastOut INT64 snapshot NULL UnicastOut
unicastIn INT64 snapshot NULL UnicastIn
vlanDetailInformation string snapshot NULL VLAN Detail Information
switchName string snapshot NULL switchName
neighborMacAddress string snapshot NULL Neighbor mac address of port.
inAclConfigName string snapshot NULL Ingress acl config name of port.
outAclConfigName string snapshot NULL egress acl config name of port.
poeClass int32 snapshot NULL PoE class of port
poePriority int32 snapshot NULL PoE priority of port
poeBudget int32 snapshot NULL PoE budget of port
lagId int32 snapshot NULL LAG ID
lagAdminStatus string snapshot NULL Admin status of LAG.
searchableVlans string snapshot NULL Searchable VLAN identifier of port
resourceName PortType snapshot NULL Identify the LAG / Physical port
isLagMember bool snapshot NULL The LAG port or Physical port
6.1.1 update
poePdClass
string snapshot NULL A PD signature which the decive learns in the process of PD-classification.
6.1.1 update
poePdClassB
string snapshot NULL Second PD class signature of dual signature PD which the device learns in the process of PD-classification.
6.1.1 update
poeLldpMaxPowerRequest
string snapshot NULL Maximum power requested by PD through LLDP in milliwatts.
6.1.1 update
poeLldpMaxPowerRequestA
string snapshot NULL In case of Dual Signature PD we have 2 channel, snAgentPoePortlldpReqPwrA is power in milliwatts for channel A.
6.1.1 update
poeLldpMaxPowerRequestB
string snapshot NULL In case of Dual Signature PD we have 2 channel. snAgentPoePortlldpReqPwrB is power in milliwatts for channel B.
6.1.1 update
poePortCapability
.com.ruckuswireless.scg.protobuf.icx.PoePortCapability     Capability of port, 0-others, 1-2pair, 2-4pair.
6.1.1 update
poe2PairMaxPower
string snapshot NULL Maximum power supported by 2pair port in milliwatts.
6.1.1 update
poe4PairMaxPower
string snapshot NULL Maximum power supported by 4pair port in milliwatts.
6.1.1 update
poeOverdriveMode
.com.ruckuswireless.scg.protobuf.icx.PoeOverDriveMode snapshot NULL Poe port overdrive mode. 0-none, 1-overdrive.

Switch Unit Status Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

id string snapshot NULL Identifier of switch unit.
switchId string snapshot NULL Identifier of switch.
upTime string snapshot NULL Uptime of switch.
unitStatus string snapshot NULL Status of switch unit.
unitSlNum string snapshot NULL Serial Number of switch unit.
domainId string snapshot NULL Domain identifier of SZ.
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch unit.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch unit.
domainName string snapshot NULL Domain name of switch unit.
switchGroupLevelOneName string snapshot NULL Level 1 Group name of switch unit.
switchGroupLevelTwoName string snapshot NULL Level 2 Group name of switch unit.
unitId int32 snapshot NULL stack unit ID.
unitState string snapshot NULL switch stacking config unit state.
unitName string snapshot NULL switch stacking config unit name.
poeUtilization int32 snapshot NULL PoE allocated capacity of switch.
poeTotal int32 snapshot NULL Total PoE capacity of switch.
poeFree int32 snapshot NULL PoE unallocated capacity of switch.SwitchUnitStatus

Connected Device Status Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

id string snapshot NULL Identifier of remote port.
remotePortMac string snapshot NULL Mac address of remote port.
remoteDeviceName string snapshot NULL Name of remote device.
remotePortType string snapshot NULL Type of remote port.
remotePortDesc string snapshot NULL Description of remote port.
localPort string snapshot NULL Local port interface.
remotePort string snapshot NULL Remote port interface.
isRuckusAP string snapshot NULL RuckusAP support of remote device.
domainId string snapshot NULL Domain identifier of SZ.
tenantId string snapshot NULL Tenant identifier of SZ.
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch group.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch group.
switchId string snapshot NULL Identifier of switch.
unitId string snapshot NULL Identifier of switch unit.
localPortIfaceName string snapshot NULL Interface name of local port.
localPortMac string snapshot NULL Mac address of local port.
domainName string snapshot NULL Domain name of SZ.
switchGroupLevelOneName string snapshot NULL Level 1 Group name of switch.
switchGroupLevelTwoName string snapshot NULL Level 2 Group name of switch.
updatedTime int64 snapshot NULL Update time of connected device information
remoteDeviceMac string snapshot NULL ConnectedDevice remote mac address.

LAG Status Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Attribute Name
lagName string snapshot NULL LAG port name.
lagId int32 snapshot NULL LAG port ID.
lagStatus string snapshot NULL LAG port status.
lagAdminStatus string snapshot NULL LAG port admin status.
vlanIds string snapshot NULL VLAN identifier of LAG port.
switchId string snapshot NULL Switch ID
unTaggedVlan string snapshot NULL Untagged VLAN of LAG port
switchUnitId string snapshot NULL Identifier of switch unit
domainName string snapshot NULL Domain name of SZ
switchGroupLevelOneName string snapshot NULL Level 1 identifier of switch group
resourceName .com.ruckuswireless.scg.protobuf.icx.PortType snapshot NULL Identify the LAG / Physical port
isLagMember bool snapshot NULL The LAG port or Physical port

Switch Client Visibility Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
id string snapshot NULL Identifier of SwitchId + SwitchPortId + ClientMAC + VLAN.
domainId string snapshot NULL Domain identifier of SZ.
tenantId string snapshot NULL Tenant identifier of SZ.
switchId string snapshot NULL Identifier of switch.
groupId string snapshot NULL Group identifier of switch.
unitId string snapshot NULL Identifier of switch unit.
switchPortId string snapshot NULL Switch port ID.
domainName string snapshot NULL Domian name
switchName string snapshot NULL Switch name
switchPort string snapshot NULL Switch Port
clientMac string snapshot NULL Mac address of client.
clientVlan string snapshot NULL VLAN of client.
clientType .com.ruckuswireless.scg.protobuf.icx.ClientType snapshot NULL Type of client.
clientAuthType .com.ruckuswireless.scg.protobuf.icx.ClientAuthType snapshot NULL Auth type of client.
clientAuthStatus .com.ruckuswireless.scg.protobuf.icx.ClientAuthStatus snapshot NULL Status of client.
clientDesc string snapshot NULL Description of client.
clientUserName string snapshot NULL User name of client.
clientIpv4Addr string snapshot NULL IPv4 adder of client.
clientIpv6Addr string snapshot NULL IPv6 adder of client.
clientUpTime string snapshot NULL Up time of client.
pastAuthHistory string snapshot NULL Past 24hour auth history of client.
createdTime INT64 snapshot NULL Create time of client information.
updatedTime INT64 snapshot NULL Update time of client information.
vlanName string snapshot NULL Name of Vlan.
historyExpirationTime INT64 snapshot NULL Used to check if pastAuthHistory is expired.
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch group.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch group.
switchGroupLevelOneName string snapshot NULL Level 1 Group name of switch.
switchGroupLevelTwoName string snapshot NULL Level 2 Group name of switch.
isRuckusAP bool snapshot NULL The wired client is RuckusAP
clientName string snapshot NULL Name of client
dot1XIpv4Addr string snapshot NULL Dot1x IPv4 address of client
dot1XIpv6Addr string snapshot NULL Dot1x IPv6 address of client
6.1.1 update
clientVni
string snapshot NULL Client VNI

Switch Configuration Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
clusterInfo .com.ruckuswireless.scg.protobuf.icx.SwitchClusterMessage snapshot NULL The cluster information.
timestamp UINT64 snapshot NULL The timestamp

Switch Cluster Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
clusterUuid string snapshot NULL Cluster UUID
clusterName string snapshot NULL Cluster name
tenantInfos .com.ruckuswireless.scg.protobuf.icx.TenantMessage snapshot NULL Group Tree System Hierarchy.

Tenant Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
tenantId string snapshot NULL Tenant UUID
tenantName string snapshot NULL Tenant name
adminDomain .com.ruckuswireless.scg.protobuf.icx.DomainMessage snapshot NULL The admin domain of tenant.

Domain Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
domainId string snapshot NULL Domain UUID
domainName string snapshot NULL Domain name
subDomainInfos .com.ruckuswireless.scg.protobuf.icx.DomainMessage snapshot NULL The list of sub-domains.
switchGroupInfos .com.ruckuswireless.scg.protobuf.icx.SwitchGroupMessage snapshot NULL The list of switch groups.

Switch Group Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
switchGroupId string snapshot NULL Switch group UUID
switchGroupName string snapshot NULL Switch group name
subSwitchGroupInfos .com.ruckuswireless.scg.protobuf.icx.SwitchGroupMessage snapshot NULL The list of switch groups.

Real time Switch Status Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
serialNumber string snapshot NULL Serial number of switch.
switchMac string snapshot NULL Mac address of switch.
domainId int32 snapshot NULL Domain UUID
domainName string snapshot NULL Domain name
switchGroupLevelOneId string snapshot NULL Level 1 identifier of switch group.
switchGroupLevelOneName string snapshot NULL Level 1 group name of switch.
switchGroupLevelTwoId string snapshot NULL Level 2 identifier of switch group.
switchGroupLevelTwoName string snapshot NULL Level 2 group name of switch.
status string snapshot NULL Connection status of switch.
operational bool snapshot NULL Switch is operational
firmwareUpgrading bool snapshot NULL Switch firmware is upgrading
ipAddress string snapshot NULL Switch IP address.
subnetMask string snapshot NULL Switch subnetmask.
defaultGateway   snapshot NULL Switch default gateway.
staticOrDynamic   snapshot NULL Switch use static IP or DHCP.
dns   snapshot NULL Switch DNS settings.
firmwareVersion   snapshot NULL Switch firmware version.
collectorExecuted bool snapshot NULL Switch collector executed.

Switch Detail Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
id string snapshot NULL Switch identifier
switchName string snapshot NULL Hostname of switch.
macAddress string snapshot NULL MAC address of switch
model string snapshot NULL Model of switch.
family string snapshot NULL Family of switch.
ipAddress string snapshot NULL Switch IP
registrationStatus string snapshot NULL Registration status of switch
numOfPorts int32 snapshot NULL Number of switch ports.
serialNumber string snapshot NULL Serial number of switch
groupName string snapshot NULL Switch group name
groupId string snapshot NULL Switch group id
status string snapshot NULL Connection status of switch
firmwareVersion string snapshot NULL The firmware version of switch
isStack bool snapshot NULL The stack status
numOfUnits uint64 snapshot NULL Number of units in the stack
szNodeAttached string snapshot NULL The SZ node id of the switch.
operational bool snapshot NULL Switch is operational

Switch Detail Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
switchDetail SwitchDetail snapshot NULL The list of attached switch detail