Local Objects

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

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

ConfigArchiveServer

config/ConfigArchiveServer

Attribute Data Type Description Permitted Values
IpAddr [Key] string IP address of the config archive server
Username string Username of config archive server.
Password string password of config archive server user. SECURE: true
DstFile string Base destination filename on server before timestamp is appended DEFAULT:"/opt/flexswitch/startup-config"
Timestamp string Option to indicate whether the file needs to be saved with timestamp. SELECTION: append/prepend/disabled
OnChange bool Automatically create an archive when a configuration change is made. DEFAULT:false
Interval uint16 Interval value for config archive in minutes. DEFAULT:1440
Timeout uint8 Time to wait before giving up on archiving (in seconds) DEFAULT:30
RetryCount uint8 Number of times to try to archvive the config before giving up DEFAULT:3
Passphrase string Passphrase for encrypting secure configurations DEFAULT: ""
Nonce string Nonce used in the encryption algorithm DEFAULT:""

XponderGlobal

config/XponderGlobal

Attribute Data Type Description Permitted Values
XponderId [Key] uint8 Xponder module identifier DEFAULT:0
XponderMode string Global operational mode of Xponder module SELECTION: InServiceWire/InServiceRegen/InServiceOverSub/
InServicePacketOptical/OutOfService
DEFAULT: OutOfService
XponderDescription string User configurable description string for the xponder module DEFAULT: This is a Voyager platform

ApiLock

config/ApiLock

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier DEFAULT: FlexSwitch
AgentId string Agent identifier DEFAULT: None
Take bool Acquire lock DEFAULT:false

State Objects

SystemStatusState

state/SystemStatus

Attribute Data Type Description Permitted Values
Name [Key] string Name of the system
Ready bool System is ready to accept api calls
Reason stringm Reason if system not ready
UpTime string Uptime of this system
NumCreateCalls string Number of create api calls made
NumDeleteCalls string Number of delete api calls made
NumUpdateCalls string Number of update api calls made
NumGetCalls string Number of get api calls made
NumActionCalls string Number of action api calls made
FlexDaemons []DaemonState Daemon states

ConfigArchiveServerState

state/ConfigArchiveServer

Attribute Data Type Description Permitted Values
IpAddr [Key] string IP address of the config archive server
Username string Username of config archive server.
DstFile string Base destination filename on server before timestamp is appended
Timestamp string Option to indicate whether the file needs to be saved with timestamp.
OnChange bool Automatically create an archive when a configuration change is made.
Interval uint16 interval value for config archive in minutes.
Timeout uint8 Time to wait before giving up on archiving (in seconds)
RetryCount uint8 Number of times to try to archvive the config before giving up
LastArchivedTimestamp string Timestamp when the config was archived for this session last time.
NextArchiveTimestamp string Timestamp when config will be archived next for this session.

SystemSwVersionState

state/SystemSwVersion

Attribute Data Type Description Permitted Values
FlexswitchVersion [Key] string Flexswitch version
Repos []RepoInfo Git repo details

ConfigLogState

state/ConfigLog

Attribute Data Type Description Permitted Values
SeqNum [Key] uint32 Sequence number of the API call
Time [Key] string When the API was called
API [Key] string Name of the API called
Operation string Opertation executed on this API
Data string User provided data
Result string Result of the API call
UserAddr string Host address from where the call was made
UserName string User who made the call

XponderGlobalState

state/XponderGlobal

Attribute Data Type Description Permitted Values
XponderId [Key] uint8 Xponder module identifier
XponderMode string Global operational mode of Xponder module
XponderDescription string User configurable description string for the xponder module

ApiInfoState

state/AipInfo

Attribute Data Type Description Permitted Values
Url [Key] string URL
Info []string APIs available under this URL or details of the specific API

ConfigStatusState

state/ConfigStatus

Attribute Data Type Description Permitted Values
Handle [Key] string Handle returned when configuration handling API was called
Status string Status of the configuration API executed
StartTime string Start time of config processing
FinishTime string Finish time of config processing
Result []ConfigResultEntry Config APIs that failed

RunningConfigState

state/RunningConfig

Attribute Data Type Description Permitted Values
Vrf [Key] string Show running config DEFAULT: All
Object string Running config for specific object DEFAULT: All
ShowDefault bool Show default values DEFAULT: true
ConfigData map[string][]interface{} Config data

ApiLockState

state/ApiLock

Attribute Data Type Description Permitted Values
SystemId [Key] string System identifier
LockedBy string Agent identifier

Structures

RepoInfo

Field Data Type Description
Name string Name of the git repo
Sha1 string Git commit Sha1
Branch string Branch name
Time string Build time

ConfigResultEntry

Field Data Type Description
Object string Object for which the configuration failed
Status string Reason for failure