SolarWinds Information Service v3.0 Schema Documentation

Index

Orion.HA.Pools

Base type: System.Entity

Summary: High Availability pools. Pool unites pool members of the same type to provide high availability of Orion servers.

Properties

Name Type Notes
PoolId System.Int32 ID of pool
PoolMasterMemberId System.Int32 ID of pool member which acts as a pool master
PoolType System.String Type of pool (0 - main poller, 1 - additional poller)
DisplayName System.String Name of a pool
Enabled System.Boolean Pool is enabled or disabled
CurrentStatus System.Int32 Current status of a pool
CurrentStatusTimestamp System.DateTime Timestamp of current status
PoolMasterChangeTimestamp System.DateTime Timestamp of pool master role change
IntervalMemberDown System.Int32 Interval after which is member considered as down
IntervalPoolTask System.Int32 Pool task interval in seconds. In this interval HA service performs regular tasks e.g. services status monitoring
IntervalSuicideRule System.Int32 Interval after which member releases its resource if it cannot reach other member of a pool do database
VirtualHostName System.String Virtual Host name assigned to a pool
VirtualIpAddress System.String Virtual IP Address assigned to a pool
DnsIpAddress System.String IP Address of DNS server hosting primary zone used by virtual host name
DnsZone System.String A name of forward lookup DNS zone where virtual host name record is stored
DnsType System.String Type of DNS server (Microsoft, BIND, Other)
DisplayName System.String
Description System.String
InstanceType System.Type
Uri System.String
InstanceSiteId System.Int32 Default='0'.
Members Orion.HA.PoolMembers Defined by relationship Orion.HA.PoolReferencesPoolMembers (System.Reference)
ResourcesInstances Orion.HA.ResourcesInstances Defined by relationship Orion.HA.PoolsResourcesInstances (System.Reference)

Verbs

Name Summary Parameters Returns
CreatePool Creates pool based on provided members and resource parameters
Name Summary
displayName Name of a pool
poolMembersIds Integer array of pool member IDs
properties Additional properties containing resources configurations.
Object which describes, whether pool was created. Property Code = 0 means that operation was successful. Property Result contains ID of created pool. Property Message contains error message in case of error.
EditPool Updates pool with a given poolId
Name Summary
poolId Pool ID
displayName Name of a pool
properties Additional properties containing resources configurations.
Object which describes, whether pool was edited. Property Code = 0 means that operation was successful. Property Message contains error message in case of error.
ValidateCreatePool Validates pool (without creating it) based on provided members and resource parameters
Name Summary
displayName Name of a pool
poolMembersIds Integer array of pool member IDs
properties Additional properties containing resources configurations.
Object which contains validation result. Property Code = 0 means that validation was successful. Property Result contains validation result data. Property Message contains error message in case of error.
ValidateEditPool Validates pool with given poolId and resource parameters (without actual update)
Name Summary
poolId Pool ID
displayName Name of a pool
properties Additional properties containing resources configurations.
Object which contains validation result. Property Code = 0 means that validation was successful. Property Result contains validation result data. Property Message contains error message in case of error.
EnablePool Enables pool with a given poolId
Name Summary
poolId ID of pool
Object which describes, whether pool was enabled. Property Code = 0 means that operation was successful. Property Message contains error message in case of error.
DisablePool Disables pool with a given poolId
Name Summary
poolId ID of pool
Object which describes, whether pool was disabled. Property Code = 0 means that operation was successful. Property Message contains error message in case of error.
DeletePool Delete pool with given poolId.
Name Summary
poolId ID of pool
Object which describes, whether pool was deleted. Property Code = 0 means that operation was successful. Property Message contains error message in case of error.
Switchover Manual failover on a given pool.
Name Summary
poolId ID of pool
Object which describes, whether manual failover was initiated. Property Code = 0 means that operation was successful. Property Message contains error message in case of error.
DeleteStaleEngine Deletes OrionServer and related pool memeber with a given hostName.
Name Summary
hostName hostName
Object which describes, whether stale engine was deleted. Property Code = 0 means that operation was successful. Property Message contains error message in case of error.