System Management Objects

This page contains descriptions of the System related objects in the FlexSwitch object models.

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

ComponentLogging

config/ComponentLogging

Attribute Data Type Description Permitted Values
Module [Key] string Module name to set logging level
Level string Logging level SELECTION: crit/err/warn/alert/emerg/notice/info/debug/trace/off
DEFAULT: err

IpTableAcl

config/IpTableAcl

Attribute Data Type Description Permitted Values
Name [Key] string Ip Table ACL rule name
PhysicalPort string Interface Name where the acl rule is to be applied, e.g: fpPort1, fpPort2 DEFAULT: all
Action string ACCEPT or DROP SELECTION: ACCEPT/DROP
IpAddr string IP address of subnet or host, e.g: 192.168.1.0/24, 192.168.1.1
Protocol string p Protocol for which rule is to be applied, e.g TCP, UDP SELECTION: tcp/udp/icmp
Port string Port for protocol, e.g for dhcprelay port is 68 DEFAULT: all

SystemParam

config/SystemParam

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier DEFAULT: FlexSwitch
Hostname string System Host Name
Description string System Description
Timezone string System timezone setting

NtpServer

config/NtpServer

Attribute Data Type Description Permitted Values
IpAddr [Key] string NTP Server IP address or fully qualified URL
SourceIntf string Interface on which the source IP is configured DEFAULT: ma1
MinPoll int32 Minpoll setting for the NTP server in seconds as a power of two MIN:3 MAX:17
DEFAULT:6
MaxPoll int32 Maxpoll setting for the NTP server in seconds as a power of two MIN:3 MAX:17
DEFAULT:10

SyslogCollector

config/SyslogCollector

Attribute Data Type Description Permitted Values
ServerIpAddr [Key] string Syslog server IPaddress
Protocol string Transport Protocol to use SELECTION: UDP/TCP
DEFAULT: UDP
Port int32 Port number on which we send syslogs DEFAULT: 514
Severity string Severity Information SELECTION: emerg/alert/crit/
err/warning/notice/info/debug
DEFAULT: *
Facility string Facility Information SELECTION: kern/user/mail/daemon/
auth/syslog/local7
DEFAULT: *
RestartFlag bool Restart on Config DEFAULT: true
SrcInf stringm Source Port from which the syslogs should reach the receiver DEFAULT: ma1

SnmpTrapServer

config/SnmpTrapServer

Attribute Data Type Description Permitted Values
Name [Key] string SNMP trap Server name
ServerAddr string SNMP trap Server IP address
SrcIntfRef string Source Interface for the trap. Default value will be the mgmt intf DEFAULT: ma1
Community string Community value for sending traps to this server DEFAULT: public
Version string Snmp version SELECTION: v2c
DEFAULT: v2c

SnmpCommunity

config/SnmpCommunity

Attribute Data Type Description Permitted Values
Name [Key] string SNMP community name DEFAULT: public
AccessType string access type for the SNMP community. SELECTION: RO/RW
DEFAULT: RO
AclRef string acl name to be used with this snmp community for access filtering. DEFAULT:""

SystemSsh

config/SystemSsh

Attribute Data Type Description Permitted Values
SystemId [Key] string System Profile Name DEFAULT: FlexSwitch
Enable bool Enable SSH service DEFAULT: true
LoginTimeout int16 Login timeout value for SSH login DEFAULT: 60
ClientAliveCount int16 Number of alive messages sent to client before the session terminates DEFAULT: 5
ClientAliveInterval int16 Time between alive messages sent to the client DEFAULT: 15
Banner string SSH banner DEFAULT: FlexSwitch
MOTD string Message of the day DEFAULT: FlexSwitch

Tacacs

config/Tacacs

Attribute Data Type Description Permitted Values
ServerIp [Key] TACACS Server IP
SourceIntf string Interface on which the source IP is configured DEFAULT: ma1
AuthService string Service requesting auth to grant user different privileges SELECTION: login/enable/ppp/
arap/pt/rcmd/x25/nasi/fwproxy
Secret string TACACS Server Secret
Port int32 TCP port of TACACS+ Server DEFAULT:49
PrivilegeLevel int32 Privilege level for the cli user MIN: 1
MAX: 15
DEFAULT: 15
Debug int32 Debug level for the cli user SELECTION:0/1
DEFAULT: 0

TacacsGlobal

config/TacacsGlobal

Attribute Data Type Description Permitted Values
ProfileName [Key] string System Profile Name DEFAULT: default
Enable string Enable TACACS Servers SELECTION: true/false
Timeout int32 TCP timeout value used to determine if a connection to server is dead. DEFAULT: 10
LogAcctDeny string Log TACACS denied commands to local syslog. SELECTION: true/false
LogAcctPass string Log TACACS passed commands to local syslog. SELECTION: true/false

User

config/User

Attribute Data Type Description Permitted Values
Name [Key] string User name
Password string User password
Access string User access level SELECTION: CLI/Admin/Sudo
DEFAULT: CLI
DefaultShell string Default shell when user logs in SELECTION: CLI"Bash
DEFAULT: CLI

SystemAPI

config/SystemAPI

Attribute Data Type Description Permitted Values
SystemId [Key] string System Profile Name DEFAULT: default
AllowProtocols string Allowed protocols SELECTION: both/http/https
DEFAULT: https
HttpPort int32 Http port DEFAULT: 80
HttpsPort int32 Https port DEFAULT: 443
AuthenticationMethod string API access authentication method SELECTION: local/tacacs/none
DEFAULT: local

DNSGlobal

config/DNSGlobal

Attribute Data Type Description Permitted Values
SystemId [Key] string DNS Gloabl configuration DEFAULT: default
Domain string Local domain name DEFAULT: ""
Timeout int16 The amount of time in seconds the resolver will wait for a response from a remote name server before retrying the query via a different name server DEFAULT: 2
Attempts int8 The number of times the resolver will send a query to its name servers before giving up and returning an error to the calling application DEFAULT: 2
Rotate bool Enable/Disable round-robin selection of nameservers from among those listed DEFAULT: true

DNSServer

config/DNSServer

Attribute Data Type Description Permitted Values
IPAddr [Key] string DNS Server IP

State Objects

IpTableAclState

state/IpTableAcl

Attribute Data Type Description Permitted Values
Name [Key] string Ip Table ACL rule name
PhysicalPort string IfIndex where the acl rule is to be applied DEFAULT: all
Action string ACCEPT or DROP
IpAddr string ip address of subnet or host, e.g: 192.168.1.0/24, 192.168.1.1
Protocol string protocol for which rule is to be applied, e.g TCP, UDP
Port string port for protocol, e.g for dhcprelay port is 68 DEFAULT: all

SystemParamState

state/SystemParam

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier
Hostname string System Host Name
SwitchMac string Switch Mac Address
SwVersion string FlexSwitch Version Information
Description string System Description
Distro string Linux distro running on this system
Kernel string Kernel version running on this system
PlatformID string Unique string identifying the underlying platform
Timezone string System timezone setting

TimezoneState

state/Timezone

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier
Timezones []string System timezone options

SnmpTrapServerState

state/SnmpTrapServer

Attribute Data Type Description Permitted Values
Name [Key] string SNMP trap Server name
ServerAddr string SNMP trap Server IP address
SrcIntfRef string Source Interface for the trap. Default value will be the mgmt intf DEFAULT: ma1
SrcIP string Primary IP corresponding to the SrcIntfRef. Default: 0.0.0.0
Community string Community value for sending traps to this server DEFAULT: public
Version string Snmp version SELECTION: v2c
DEFAULT: v2c

SystemCoreState

state/SystemCore

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier
CoreFiles []string show the core files generated
CoreLocation string Location where core files are located

SystemUptimeState

state/SystemUptime

Attribute Data Type Description Permitted Values
SystemId [Key] string Length of time the system has been up

SystemClockState

state/SystemClock

Attribute Data Type Description Permitted Values
SystemId [Key] string System date in UTC

SystemMemoryState

state/SystemMemory

Attribute Data Type Description Permitted Values
SystemId [Key] string System Id
MemTotal int32 Total memory (in kB)
MemFree int32 Free memory (in kB)
Cached int32 Cached memory (in kB)
SwapCached int32 Cached swap memory (in kB)
SwapTotal int32 Total swap memory (in kB)
SwapFree int32 Free swap memory (in kB)

SystemProcessState

_state/SystemProcess_

Attribute Data Type Description Permitted Values
Name [Key] string Process(Daemon) Name
CpuUsage string Percentage CPU Usage
MemoryUsage string Percentage Memory Usage

TechSupportState

state/TechSupportState

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier
SupportFile string Tech support file that is generated
CollectionStatus string Indicates if the tech support collection is successful or already executed.
TimestampForLastRun string Indicates the timestamp when the command was successfully run last time.

NtpServerState

state/NtpServer

Attribute Data Type Description Permitted Values
IpAddr [Key] string NTP Server IP address or fully qualified URL
SourceIntf string Interface on which the source IP is configured DEFAULT: ma1
MinPoll int32 Minpoll setting for the NTP server in seconds as a power of two MIN:3 MAX:17
DEFAULT:6
MaxPoll int32 Maxpoll setting for the NTP server in seconds as a power of two MIN:3 MAX:17
DEFAULT:10

DaemonState

state/Daemon

Attribute Data Type Description Permitted Values
Name [Key] string Daemon name
Enable bool True if the daemon is enabled
State string State of the daemon up, starting, restarting, stopped
Reason string Reason for the current state of the daemon
StartTime string Daemon start time
KeepAlive string KeepAlive state of the daemon
RestartCount int32 Number of times this daemon has been restarted
RestartTime string Last restart time
RestartReason string Last restart reason

SystemParamState

state/SystemParam

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier
Hostname string System Host Name
SwitchMac string Switch Mac Address
SwVersion string FlexSwitch Version Information
Description string System Description
Distro string Linux distro running on this system
Kernel string Kernel version running on this system
PlatformID string Unique string identifying the underlying platform
Timezone string System timezone setting

TacacsState

state/Tacacs

Attribute Data Type Description Permitted Values
ServerIp [Key] string TACACS Server IP
SourceIntf string Interface on which the source IP is configured
SourceIp string Primary IP corresponding to the SourceIntf Default:"0.0.0.0
AuthService string Service requesting auth to grant user different privileges
Port int32 TCP port of TACACS+ Server
PrivilegeLevel int32 Privilege level for the cli user
Debug int32 Debug level for the cli user, used to display TACAC's debug information
ConnFailReason string Connection to server failure reason

TacacsGlobalState

state/TacacsGlobal

Attribute Data Type Description Permitted Values
ProfileName [Key] string System Profile Name
OperStatus string Operational Status of TACACS Servers
NumActiveSessions int32 Number of active sessions

UserState

state/User

Attribute Data Type Description Permitted Values
Name [Key] string User name
UserId uint16 User ID
BashAccess bool User has bash access
SudoAccess bool User has sudo access
DefaultShell string Default shell when user logs in

UserSessionState

state/UserSession

Attribute Data Type Description Permitted Values
Name [Key] string User name
TTY string TTY"
From string Logged in from
IdleTime string Idle time
Application string Running application"

DNSGlobalState

state/DNSGlobal

Attribute Data Type Description Permitted Values
SystemId [Key] string DNS Gloabl configuration DEFAULT: default
Domain string Local domain name
Timeout uint16 The amount of time in seconds the resolver will wait for a response from a remote name server before retrying the query via a different name server
Attempts uint8 The number of times the resolver will send a query to its name servers before giving up and returning an error to the calling application
Rotate bool Enable/Disable round-robin selection of nameservers from among those listed

DNSServerState

state/DNSServer

Attribute Data Type Description Permitted Values
IPAddr [Key] string DNS Server IP