Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The full list of queryable FQL fields for each object is set out below.

 

Filter keys for AffinityKey object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| inherittoserver | boolean | If this is set to 1 this key will be automatically inherited by the server |
| keyname | String | Name of the affinity key |
| keyvalue | double | Holds the default affinity value |
| keyweight | double | The weight given to the key |
{table-plus}

Filter keys for ClusterConfig object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| clusterip | String | The endpoint of the XVP service |
| clustername | String | Timestamp |
| clusterport | int | The port for the service |
| clusteruuid | String | The name of the cluster |
| hypervisor | Hypervisor | The hypervisor of the cluster |
| hypervisorcapability | long | The type of integration used by the cluster - 0 - none, 1 - UCS |
| macaddressprefix | String | The mac address prefix for the cluster |
| password | String | The password for the XVP service |
| username | String | The usename for the XVP service |
| vlanendinnertag | int | The maximum VLAN tag to be allocated |
| vlanendoutertag | int | In the QinQ mode maximum outer tag which can be allocated |
| vlanqinqmode | boolean | Indicates if QinQ mode is active |
| vlanrestrictedinnertags | String | The tags which are restricted - a comma seperated list |
| vlanrestrictedoutertags | String | The tags which are restricted in QinQ mode - a comma seperated list |
| vlanstartinnertag | int | The minimum VLAN tag to be allocated |
| vlanstartoutertag | int | When VLAN allocation is runing in the QinQ mode this will be used as the start tag |
{table-plus}

Filter keys for Disk object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| bootable | boolean | Indicates whether the disk is bootable |
| connpath | String | The path known in the storage unit this is the way node will connect to the disk |
| diskname | String | This name is given by CP or any other entity |
| disktype | DiskType | Indicates the disk type |
| diskusage | long | The actual disk usage (MB) |
| inuse | int | Mark the disk to be in use. 1--> in use 0 -> to be delted |
| size | int | Size of the disk |
| storageunit | String | The storage unit disk belongs to |
{table-plus}

Filter keys for DiskSnap object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| diskcapacity | int | The capacity of the disk when the snapshot was taken |
| inuse | boolean | If this flag is 0 that means this snapshot will not be in use |
| sizeonsnapshot | int | Holds the disk size when the snapshot is taken |
| snapshotname | String | The name of the snapshot |
| timestamp | long | Timestamp |
{table-plus}

Filter keys for FetchResource object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| buildconfig | String | Holds xml data which comes in to buildComplete callback |
| checksum | String | Specified checksum for the downloading object |
| errormsg | String | 	This will hold the details about the error which happened fetching the resource |
| fetchconfig | String | 	Holds the XML configs which comes to fetchComplete call this is used to build tigerlily objects |
| fetchlimits | String | Holds the limits send by the external system the limits will be in following format |
| fetchname | String | Name to be set on the object after creation |
| fetchsize | long | Size of the downloaded object in bytes |
| password | String | Password for the given users |
| state | ResourceState | State of the fetch |
| storageunit | String | Holds the  storage unit where this disk is being fetched to |
| type | ResourceType | Type of the object which have been fetched |
| url | String | URL path where the resource can be fetched from |
| username | String | 	Username to download the resource form the given url in any, i.e a basic auth user or a ftp username  |
{table-plus}

Filter keys for Firewall object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| state | int | Indicates whether the firewall is active |
{table-plus}

Filter keys for Ip object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| address | String | The IP address |
| dhcp | short | Indicates if the IP addres in DHCP configfured or not |
| iptype | short | If ip_type = 1 this is a IPv4 address if ip_type=2 its a ipv6 address |
| type | short | Indicate if the IP is a public or private IP if type 1 its public 0 fro private  |
{table-plus}

Filter keys for IpPool object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| ipmode | short | 1 = pvip, 2 = vlan |
| iptype | short | 1 = ipv4, 2 = ipv6 |
| mask | short | The netmask |
| startip | String | The first available IP |
{table-plus}

Filter keys for Nic object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| macaddress | String | Mac address given to the virtual server |
| nicindex | int | The order to load nics. 0=add at end, 1=in order |
{table-plus}

Filter keys for Node object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| availablecpu | short | Available CPU on the node |
| availableram | long | Available RAM with on the node in MB |
| clusterref | String | A reference ID unique to the node with the cluster |
| clusteruuid | String | The cluster uuid |
| configgroup | long | The config group of the node |
| connectedsus.active | boolean | Indicates if the SU is active or not, This will come to effect when local storage units go offline. |
| connectedsus.backingtype | StorageBackingType |  |
| connectedsus.connectiondata | String |  |
| connectedsus.data | String | Hold addtional data about the storage unit e.g IQN etc |
| connectedsus.diskcontentionratio | short |  |
| connectedsus.freespace | long | This will indicate the free space in KB avilable to create disks, plese note all the disk will created as sparse files |
| connectedsus.isdefault | boolean | Indicates whether this is the default storage unit to use |
| connectedsus.managementip | String |  |
| connectedsus.minspacefactor | float |  |
| connectedsus.storageunitgroupuuid | String |  |
| connectedsus.storageunitname | String | The name of the storage unit |
| connectedsus.storageunitstate | StorageUnitState |  |
| connectedsus.storageunituuid | String | The UUID of the storage unit |
| connectedsus.totalspace | long | This will indicate the total space in KB of the SU |
| connectedsus.type | StorageUnitType | The type of the storage unit |
| connectedsus.user | String |  |
| cpucontentionratio | double | Indicate minimum amount of vcpus you are willing to put in a physical core |
| currentload | double | Current load on the node |
| hypervisordata | String | And specific data that used by hypervisors |
| macaddress | String[] | The mac address(es) of the node |
| metadata | String | Any metadata associated with the node such as UCS service profile |
| networkstatus | String | Status of network on the node |
| nodealias | String | An optional alternate node connection address |
| nodetype | TLNodeType | 1=hypervisor, 2=router |
| numberofservers | long | Number of server with currently running in the node |
| ramcontentionratio | double | Ram contention of the node |
| ramwithoutcontention | long | This will be updated when a VM get registered and unregistered from a VM |
| referencekey | String | Reference key for use by UCS etc |
| routergroup | long | The router group of the node |
| routerstate | NodeRouterState | This only applies if it is in router mode 0-> slave, 1-> master, otherwise -1 |
| servers.bootorder | int | Contains the boot sequence of the server in the VDC |
| servers.clonedfrom | long | The server snapshot this server was cloned from |
| servers.clonetype | CloneType | 0 - server, 1 -snapshot |
| servers.clusterref | String | Cluster reference |
| servers.container | Boolean |  |
| servers.cpu | int | The CPUs on the server |
| servers.disklist.bootable | boolean | Indicates whether the disk is bootable |
| servers.disklist.connpath | String | The path known in the storage unit this is the way node will connect to the disk |
| servers.disklist.diskname | String | This name is given by CP or any other entity |
| servers.disklist.disktype | DiskType | Indicates the disk type |
| servers.disklist.diskusage | long | The actual disk usage (MB) |
| servers.disklist.inuse | int | Mark the disk to be in use. 1--> in use 0 -> to be delted |
| servers.disklist.size | int | Size of the disk |
| servers.disklist.storageunit | String | The storage unit disk belongs to |
| servers.ram | int | The ram in MB |
| servers.runningnode | Long |  |
| servers.serverdata | String | Server data |
| servers.servername | String | This name is given by the CP or a entity, this name is also the server name used in XVP |
| servers.status | int | 0: stopped, 1:running, 2:starting, 3:stopping, 4:rebooting |
| softwarestatus | String | Status of software on the node |
| state | NodeState | The state of the node 0 - > not running, 1 -> running , 2 -> maintanence , 3 -> spare |
| vnodeip | String | Virtual router node's ip address, not supported on all the hypervisors |
| vnodestate | NodeState | Virtual router node's status, not supported on all the hypervisors |
{table-plus}

Filter keys for RouterGroup object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| clusteruuid | String | The cluster uuid |
| maximuminnertag | int | Maximum inner tag |
| maximumoutertag | int | Maximum outer tag |
| minimuminnertag | int | Minimum inner tag |
| minimumoutertag | int | Minimum outer tag |
| routergroupname | String | Name of the router group |
{table-plus}

Filter keys for ServerSnap object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| descriptor | String | Descriptor associated with the snapshot |
| inuse | boolean | If this flag is 0 that means this snapshot will not be in use |
| snapshotname | String | The name of the snapshot |
| storage_size | int | Holds the total disk size when the snapshot is taken |
| timestamp | long | Timestamp |
{table-plus}

Filter keys for StoragePool object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| active | int | -1 = deleted, 0 = inactive, 1 = active, 2 = working (adding disks) |
| size | int | The number of clones |
| storageunits | String[] | Which storage units to use |
{table-plus}

Filter keys for StorageUnit object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| active | boolean | Indicates if the SU is active or not, This will come to effect when local storage units go offline. |
| backingtype | StorageBackingType |  |
| connectiondata | String |  |
| data | String | Hold addtional data about the storage unit e.g IQN etc |
| diskcontentionratio | short |  |
| freespace | long | This will indicate the free space in KB avilable to create disks, plese note all the disk will created as sparse files |
| isdefault | boolean | Indicates whether this is the default storage unit to use |
| managementip | String |  |
| minspacefactor | float |  |
| storageunitgroupuuid | String |  |
| storageunitname | String | The name of the storage unit |
| storageunitstate | StorageUnitState |  |
| storageunituuid | String | The UUID of the storage unit |
| totalspace | long | This will indicate the total space in KB of the SU |
| type | StorageUnitType | The type of the storage unit |
| user | String |  |
{table-plus}

Filter keys for Subnet object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| broadcastaddresslong | long | The broadcast address of the subnet |
| gatewayaddresslong | long | The default route of the subnet |
| mask | int | The netmask of the subnet |
| networkaddresslong | long | The network address of the subnet |
| startip | long | Sent by network service |
| systemallocated | int | Indicates whether the IP address is allocated by the system |
{table-plus}

Filter keys for Subnet6 object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| mask | int |  |
| networkprefix | String |  |
| routerenabled | boolean |  |
| systemallocated | int | Indicates whether the IP address is allocated by the system |
{table-plus}

Filter keys for TLStorageConnections object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| managementip | String |  |
{table-plus}

Filter keys for VNCDetails object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| handler | VncHandlerType | Handler type |
| nodedomain | String | Node domain |
| nodeip | String | VNC node IP |
| nodepassword | String | The password for the node |
| nodeport | int | VNC node port |
| nodeusername | String | The username for the node |
| password | String | VNC password of the server |
| preconnectionblob | String | Pre connection data |
| protocol | VNCProtocolType | VNC protocol |
| proxyip | String | Ip address of the cluster proxy server |
| proxyport | int | VNC proxy port |
| sessionkey | String | Holds the autogenerated session key |
| sessionstarttime | long | Session start time in milliseconds |
{table-plus}

Filter keys for Vdc object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| state | boolean | The state of the VDC |
| usedasstoragegroup | boolean | Indicates if the vdc is used as a group with in the storage dirver |
| vdcname | String | The name of the VDC |
{table-plus}

Filter keys for VirtualServer object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| bootorder | int | Contains the boot sequence of the server in the VDC |
| clonedfrom | long | The server snapshot this server was cloned from |
| clonetype | CloneType | 0 - server, 1 -snapshot |
| clusterref | String | Cluster reference |
| container | Boolean |  |
| cpu | int | The CPUs on the server |
| disklist.bootable | boolean | Indicates whether the disk is bootable |
| disklist.connpath | String | The path known in the storage unit this is the way node will connect to the disk |
| disklist.diskname | String | This name is given by CP or any other entity |
| disklist.disktype | DiskType | Indicates the disk type |
| disklist.diskusage | long | The actual disk usage (MB) |
| disklist.inuse | int | Mark the disk to be in use. 1--> in use 0 -> to be delted |
| disklist.size | int | Size of the disk |
| disklist.storageunit | String | The storage unit disk belongs to |
| ram | int | The ram in MB |
| runningnode | Long |  |
| serverdata | String | Server data |
| servername | String | This name is given by the CP or a entity, this name is also the server name used in XVP |
| status | int | 0: stopped, 1:running, 2:starting, 3:stopping, 4:rebooting |
{table-plus}

Filter keys for Vlan object

Wiki Markup
{table-plus:columnTypes=S,S,S|sortColumn=1}
|| Name || Data type || Description ||
| allocationtype | AllocationType | Indicates if the VLAN was allocated via the system or directly added via a user, i.e on vlan internetworking level |
| clusterconfig | boolean | Indicates if the VLAN is created in the cluster |
| trafficin | long | Inbound traffic count |
| trafficout | long | Outbound traffic count |
| vlaninnertag | int | Given by the network service |
| vlanname | String | Given by the network service |
| vlanoutertag | int | Given by the network service |
{table-plus}