## Uses of Class
com.h3c.sdn.system.SystemInformation

- Packages that use SystemInformation
  Package | Description
  --- | ---
  com.h3c.sdn | Definitions of domain model and related general constructs which are applicable to multiple tiers and software layers of the SDN Controller.
  com.h3c.sdn.adm | Definitions of the domain model and services specific to the Administrator tier of the VCF Controller.
  com.h3c.sdn.adm.dao | Definitions of data access services for persisting and retrieving information applicable at the Administrator tier of the SDN Controller.
  com.h3c.sdn.adm.json | Implementations of Core Services JSON factory and associated codecs.
  com.h3c.sdn.adm.system | Definitions of services pertaining to the SDN Controller system and its collaborators.
  com.h3c.sdn.alert | Definitions of the domain model pertaining to the Alerts.
  com.h3c.sdn.api | Definitions of services for driving outbound external communications for interacting with peers and integrating with other external applications, e.g.
  com.h3c.sdn.auditlog | Definitions of the domain model pertaining to the Audit Logs.
  com.h3c.sdn.ctlAddrManager |
  com.h3c.sdn.hostManager |
  com.h3c.sdn.system | Definitions of the domain model pertaining to the SDN Controller system.
  com.h3c.sdn.team | Teaming services and concepts universally available to all modules.

- - ### Uses of SystemInformation in com.h3c.sdn

    Methods in com.h3c.sdn that return types with arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `Id<SystemInformation,UUID>` | SystemModel.`getSysId()` Returns the system identification.

    Constructor parameters in com.h3c.sdn with type arguments of type SystemInformation
    Constructor and Description
    `SystemModel(Id<? extends T,UUID> id, Id<SystemInformation,UUID> sysId)` Construct using the supplied unique identification and system identification strings.
    `SystemModel(Id<SystemInformation,UUID> sysId)` Construct with the given system identification string.

  - ### Uses of SystemInformation in com.h3c.sdn.adm

    Methods in com.h3c.sdn.adm that return types with arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `<R,I> Collection<Pair<SystemInformation,Result<R,Exception,TeammateCommandExecutorService.CancellationCause>>>` | TeammateCommandExecutorService.`execute(TeammateCommandExecutorService.Command<R,I,SystemInformation> command, I input)` Executes a command across the team (After a team has been created).

    Method parameters in com.h3c.sdn.adm with type arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `<R,I> Collection<Pair<SystemInformation,Result<R,Exception,TeammateCommandExecutorService.CancellationCause>>>` | TeammateCommandExecutorService.`execute(TeammateCommandExecutorService.Command<R,I,SystemInformation> command, I input)` Executes a command across the team (After a team has been created).
    `<R,I> void` | TeammateCommandExecutorService.`execute(TeammateCommandExecutorService.Command<R,I,SystemInformation> command, I input, TeammateCommandExecutorService.CommandListener<R,SystemInformation> listener)` Executes a command across the team (After a team has been created).
    `<R,I> void` | TeammateCommandExecutorService.`execute(TeammateCommandExecutorService.Command<R,I,SystemInformation> command, I input, TeammateCommandExecutorService.CommandListener<R,SystemInformation> listener)` Executes a command across the team (After a team has been created).

  - ### Uses of SystemInformation in com.h3c.sdn.adm.dao

    Methods in com.h3c.sdn.adm.dao that return types with arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `ReadQuery<List<SystemInformation>>` | QueryService.`getFindSystemsQuery(SystemInformationFilter filter, SortSpecification<SystemInformationSortAttribute> sortSpecification)` Creates a query to find systems in the database.
    `ReadQuery<SystemInformation>` | QueryService.`getGetSystemInformationQuery(Id<SystemInformation,UUID> id)` Creates a query that gets a system by its id.
    `WriteQuery<SystemInformation>` | QueryService.`getUpdateSystemInformationQuery(SystemInformation systemInformation)` Creates a query to update a system in the database.

    Methods in com.h3c.sdn.adm.dao with parameters of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `WriteQuery<Boolean>` | QueryService.`getAddSystemInformationQuery(SystemInformation systemInformation)` Creates a query to add a system information.
    `WriteQuery<SystemInformation>` | QueryService.`getUpdateSystemInformationQuery(SystemInformation systemInformation)` Creates a query to update a system in the database.

    Method parameters in com.h3c.sdn.adm.dao with type arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `WriteQuery<Void>` | QueryService.`getDeleteSystemInformationQuery(Id<SystemInformation,UUID> id)` Creates a query that deletes a system.
    `ReadQuery<SystemInformation>` | QueryService.`getGetSystemInformationQuery(Id<SystemInformation,UUID> id)` Creates a query that gets a system by its id.

  - ### Uses of SystemInformation in com.h3c.sdn.adm.json

    Methods in com.h3c.sdn.adm.json that return SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `SystemInformation` | SystemInformationCodec.`decode(com.fasterxml.jackson.databind.node.ObjectNode node)`

    Methods in com.h3c.sdn.adm.json with parameters of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `com.fasterxml.jackson.databind.node.ObjectNode` | SystemInformationCodec.`encode(SystemInformation si)`

  - ### Uses of SystemInformation in com.h3c.sdn.adm.system

    Methods in com.h3c.sdn.adm.system that return SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `SystemInformation` | SystemInformationService.`addSystem(SystemInformation systemInfo)` Adds a new system into the team.
    `SystemInformation` | SystemInformationService.`getSystem()` Gets the local system information.
    `SystemInformation` | SystemInformationService.`getSystem(Id<SystemInformation,UUID> id)` Get the system information with the specified unique id.
    `SystemInformation` | SystemInformationService.`setSelfIp(IpAddress ip)` Set the IP address of the non-teamed, self=true system.

    Methods in com.h3c.sdn.adm.system that return types with arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `Collection<SystemInformation>` | SystemInformationService.`getSystems()` Gets all known systems.

    Methods in com.h3c.sdn.adm.system with parameters of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `SystemInformation` | SystemInformationService.`addSystem(SystemInformation systemInfo)` Adds a new system into the team.
    `void` | SystemInformationService.`registerContact(SystemInformation contact)` Registers a contact from another system.
    `void` | SystemInformationService.`updateSystem(SystemInformation systemInfo)` Updates the system information using the supplied descriptor.

    Method parameters in com.h3c.sdn.adm.system with type arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `void` | SystemWatchdogService.`contactSystem(Id<SystemInformation,UUID> id)` Forces a contact with the specified system.
    `SystemInformation` | SystemInformationService.`getSystem(Id<SystemInformation,UUID> id)` Get the system information with the specified unique id.
    `void` | SystemInformationService.`removeSystem(Id<SystemInformation,UUID> id)` Removes the system with the specified unique id.

  - ### Uses of SystemInformation in com.h3c.sdn.alert

    Constructor parameters in com.h3c.sdn.alert with type arguments of type SystemInformation
    Constructor and Description
    `Alert(Id<Alert,UUID> id, Id<SystemInformation,UUID> sysId, boolean state, String topicId, String origin, Date timestamp, Severity severity, String description)` Constructs an instance of an Alert with a unique identification.
    `Alert(Id<SystemInformation,UUID> sysId, boolean state, String topicId, String origin, Date timestamp, Severity severity, String description)` Constructs an instance of an Alert.

  - ### Uses of SystemInformation in com.h3c.sdn.api

    Methods in com.h3c.sdn.api that return SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `SystemInformation` | SystemContactService.`contactSystem(IpAddress remoteSystem)` Sends the local system information to another system and uses the response to update the other system's information.

    Methods in com.h3c.sdn.api with parameters of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `File` | LogCollectionService.`collectLogs(File zipFile, SystemInformation systemInfo)` Collect logs from the specified system.
    `MessageFuture` | RemoteControllerService.`enablePort(SystemInformation system, DataPathId dpid, BigPortNumber port, boolean enable)` Instructs the controller to enable or disable the given port on the specified datapath.
    `Pair<List<AuditLogEntry>,DataSize>` | AuditLogTransferService.`get(SystemInformation self, SystemInformation system, Date from)` Requests audit logs from the given system.
    `Pair<List<Alert>,DataSize>` | AlertTransferService.`get(SystemInformation self, SystemInformation system, Date from)` Requests alerts from the given system.
    `Set<DataPathInfo>` | RemoteControllerService.`getAllDataPathInfo(SystemInformation system)` Returns information describing each of the OpenFlow datapaths currently connected to the controller running in the specified system.
    `List<Port>` | RemoteControllerService.`getAllPorts(SystemInformation system, DataPathId dpid)` Returns the information from the team of controllers forming a cluster describing each of the ports currently connected for the given datapath
    `List<Application>` | ApplicationTransferService.`getApplications(SystemInformation system)` Get list of applications from a team member.
    `InputStream` | ApplicationTransferService.`getArchive(SystemInformation system, String appId)` Get an application archive file from a team member.
    `List<Config>` | ConfigTransferService.`getConfigs(SystemInformation system)` Get `Config`s for all components (default and modified).
    `DataPathInfo` | RemoteControllerService.`getDataPathInfo(SystemInformation system, DataPathId dpId)` Returns information from a particular member controller describing a specific OpenFlow datapath.
    `List<MBodyExperimenter>` | RemoteControllerService.`getExperimenter(SystemInformation system, DataPathId dpId)` Lists meters from a particular member controller configured on the specified datapath.
    `List<MBodyFlowStats>` | RemoteControllerService.`getFlows(SystemInformation system, DataPathId dpId, TableId tableId)` Returns the flows installed from a particular member controller in the specified table of the given datapath.
    `List<MBodyGroupDescStats>` | RemoteControllerService.`getGroupDescription(SystemInformation system, DataPathId dpId)` Returns the groups description from a particular member controller configured for the specified datapath.
    `MBodyGroupDescStats` | RemoteControllerService.`getGroupDescription(SystemInformation system, DataPathId dpId, GroupId groupId)` Returns the group description from a particular member controller configured on the specified datapath and groupId.
    `MBodyGroupFeatures` | RemoteControllerService.`getGroupFeatures(SystemInformation system, DataPathId dpid)` Returns the supported group features for the specified datapath.
    `List<MBodyGroupStats>` | RemoteControllerService.`getGroupStats(SystemInformation system, DataPathId dpId)` Returns the groups statistics from a particular member controller configured for the specified datapath.
    `MBodyGroupStats` | RemoteControllerService.`getGroupStats(SystemInformation system, DataPathId dpId, GroupId groupId)` Returns the group statistics from a particular member controller configured for the specified datapath and groupId.
    `String[]` | LicenseTransferService.`getLicenses(SystemInformation system)` Get all licenses stored in database.
    `List<AlertTopicListener>` | AlertTopicListenerTransferService.`getListeners(SystemInformation system)` Returns the list of registered Alert Topic listeners.
    `List<MBodyMeterConfig>` | RemoteControllerService.`getMeterConfig(SystemInformation system, DataPathId dpId)` Lists meters configuration from a particular member controller configured on the specified datapath.
    `MBodyMeterConfig` | RemoteControllerService.`getMeterConfig(SystemInformation system, DataPathId dpid, MeterId meterId)` Returns the meter configuration for the given meter ID, from the specified datapath.
    `MBodyMeterFeatures` | RemoteControllerService.`getMeterFeatures(SystemInformation system, DataPathId dpid)` Returns the meter features for the specified datapath.
    `List<MBodyMeterStats>` | RemoteControllerService.`getMeterStats(SystemInformation system, DataPathId dpId)` Lists meters statistic from a particular member controller configured on the specified datapath.
    `MBodyMeterStats` | RemoteControllerService.`getMeterStats(SystemInformation system, DataPathId dpid, MeterId meterId)` Returns the meter statistics for the given meter ID, from a particular member controller configured on the specified datapath.
    `Port` | RemoteControllerService.`getPorts(SystemInformation system, DataPathId dpid, long portid)` Returns the information from the team of controllers forming a cluster describing each of the ports currently connected for the given datapath for the given port id.
    `List<MBodyPortStats>` | RemoteControllerService.`getPortStats(SystemInformation system, DataPathId dpid)` Returns the port statistics from the specified datapath.
    `MBodyPortStats` | RemoteControllerService.`getPortStats(SystemInformation system, DataPathId dpid, BigPortNumber portNumber)` Returns the port statistics for the given port, from the specified datapath.
    `List<Region>` | RegionTransferService.`getRegions(SystemInformation system)` Get all regions from given controller.
    `ControllerStats` | RemoteControllerService.`getStats(SystemInformation system)` Returns statistical information about the controller.
    `String` | LicenseTransferService.`installId(SystemInformation system)` Get the install id assigned for this install base.
    `List<MessageFuture>` | RemoteControllerService.`send(SystemInformation system, List<OpenflowMessage> msgs, DataPathId dpId)` Instructs a particular member controller to send the specified list of messages (in order) to the specified datapath.
    `MessageFuture` | RemoteControllerService.`send(SystemInformation system, OpenflowMessage msg, DataPathId dpId)` Instructs a particular member controller to send the specified message to the specified datapath.
    `File` | BackupTransferService.`sendDownloadBackup(SystemInformation si, boolean csum)` Download backup to a safe location
    `MessageFuture` | RemoteControllerService.`sendFlowMod(SystemInformation system, OfmFlowMod flowMod, DataPathId dpId)` Dispatches the OpenFlow FlowMod message from a particular member controller to the given datapath via the Flow Tracker.
    `BackupInformation` | BackupTransferService.`sendGetLastRestoreInformation(SystemInformation si)` Get last backup information.
    `MessageFuture` | RemoteControllerService.`sendGroupMod(SystemInformation system, OfmGroupMod groupMod, DataPathId dpid)` Sends the given GROUP_MOD message from a particular member controller to the specified datapath.
    `MessageFuture` | RemoteControllerService.`sendMeterMod(SystemInformation system, OfmMeterMod meterMod, DataPathId dpId)` Sends the OpenFlow METER_MOD message from a particular member controller to the specified datapath.
    `Token` | BackupTransferService.`sendStartSystemBackup(SystemInformation si)` Backup controller system.
    `Token` | BackupTransferService.`sendStartSystemRestore(SystemInformation si)` Restore controller system.
    `void` | BackupTransferService.`sendUploadBackup(String filename, InputStream in, SystemInformation si)` Upload backup to a URL.

  - ### Uses of SystemInformation in com.h3c.sdn.auditlog

    Constructor parameters in com.h3c.sdn.auditlog with type arguments of type SystemInformation
    Constructor and Description
    `AuditLogEntry(Id<AuditLogEntry,UUID> id, Id<SystemInformation,UUID> sysId, String user, String origin, Date timestamp, String activity, String description)` Constructs an Audit Log Entry using the supplied unique identification and system identification.
    `AuditLogEntry(Id<SystemInformation,UUID> sysId, String user, String origin, Date timestamp, String activity, String description)` Constructs an Audit Log Entry.

  - ### Uses of SystemInformation in com.h3c.sdn.ctlAddrManager

    Constructor parameters in com.h3c.sdn.ctlAddrManager with type arguments of type SystemInformation
    Constructor and Description
    `CtlAddrEntity(Id<CtlAddrEntity,UUID> id, Id<SystemInformation,UUID> sysId, IpAddress ipAddr, IpAddress maskIpAddr, MacAddress macAddr, VId vid)`
    `CtlAddrEntity(Id<SystemInformation,UUID> sysId, IpAddress ipAddr, IpAddress maskIpAddr, MacAddress macAddr, VId vid)`

  - ### Uses of SystemInformation in com.h3c.sdn.hostManager

    Constructor parameters in com.h3c.sdn.hostManager with type arguments of type SystemInformation
    Constructor and Description
    `HostEntity(Id<HostEntity,UUID> id, Id<SystemInformation,UUID> sysId, IpAddress ipAddr, MacAddress macAddr, VId vid, DataPathId dpid, BigPortNumber port, int ctlId, boolean state)`
    `HostEntity(Id<SystemInformation,UUID> sysId, IpAddress ipAddr, MacAddress macAddr, VId vid, DataPathId dpid, BigPortNumber port, int ctlId, boolean state)`

  - ### Uses of SystemInformation in com.h3c.sdn.system

    Constructors in com.h3c.sdn.system with parameters of type SystemInformation
    Constructor and Description
    `SystemInformation(SystemInformation si)` Construct a deep copy of another SystemInformation object.

    Constructor parameters in com.h3c.sdn.system with type arguments of type SystemInformation
    Constructor and Description
    `SystemInformation(Id<SystemInformation,UUID> id, boolean isSelf, IpAddress address)` Construct a new system descriptor using the supplied unique identification.

  - ### Uses of SystemInformation in com.h3c.sdn.team

    Method parameters in com.h3c.sdn.team with type arguments of type SystemInformation
    Modifier and Type | Method and Description
    --- | ---
    `void` | TeamListener.`processTeamEvent(TeamEvent event, Id<SystemInformation,UUID> instanceId)` This callback is implemented by applications to process team status change notifications.

Copyright © 2014. All Rights Reserved.