Represents a Virtual Element associated with a virtual domain.
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/VDAssociatedVirtualElements
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Response Parameters
clusterId
Long
|
Id of the cluster this Virtual Element belongs to
|
clusterName
String
|
Name of the cluster this Virtual Element belongs to
|
datacenterId
Long
|
Id of the datacenter this Virtual Element belongs to
|
datacenterName
String
|
Name of the datacenter this Virtual Element belongs to
|
discoverySource
String
|
Virtual Element discovery source
|
ipAddress
String
|
Virtual Element IP address
|
name
String
|
|
parentId
long
|
Id of the parent Virtual Element
|
type
String
|
Virtual Element type (Datacenter, Cluster, Host)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.64.80.159/webacs/api/v1/data/VDAssociatedVirtualElements/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedVirtualElements" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v1/data/VDAssociatedVirtualElements/15" rootUrl="https://10.64.80.159/webacs/api/v1/data">
<entity dtoType="vDAssociatedVirtualElementsDTO" type="VDAssociatedVirtualElements" url="https://10.64.80.159/webacs/api/v1/data/VDAssociatedVirtualElements/15">
<vdAssociatedVirtualElementsDTO displayName="String value" id="15" uuid="String value">
<clusterId>15</clusterId>
<clusterName>String value</clusterName>
<datacenterId>15</datacenterId>
<datacenterName>String value</datacenterName>
<discoverySource>String value</discoverySource>
<ipAddress>String value</ipAddress>
<name>String value</name>
<parentId>2</parentId>
<type>String value</type>
</vdAssociatedVirtualElementsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.80.159/webacs/api/v1/data/VDAssociatedVirtualElements/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedVirtualElements",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/data\/VDAssociatedVirtualElements\/15",
"@rootUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "vDAssociatedVirtualElementsDTO",
"@type" : "VDAssociatedVirtualElements",
"@url" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/data\/VDAssociatedVirtualElements\/15",
"vdAssociatedVirtualElementsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"clusterId" : 15,
"clusterName" : "String value",
"datacenterId" : 15,
"datacenterName" : "String value",
"discoverySource" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"parentId" : 2,
"type" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/VDAssociatedVirtualElements
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
clusterId
Long
|
Id of the cluster this Virtual Element belongs to
|
clusterName
String
|
Name of the cluster this Virtual Element belongs to
|
datacenterId
Long
|
Id of the datacenter this Virtual Element belongs to
|
datacenterName
String
|
Name of the datacenter this Virtual Element belongs to
|
discoverySource
String
|
Virtual Element discovery source
|
ipAddress
String
|
Virtual Element IP address
|
name
String
|
|
parentId
long
|
Id of the parent Virtual Element
|
type
String
|
Virtual Element type (Datacenter, Cluster, Host)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.64.80.159/webacs/api/v2/data/VDAssociatedVirtualElements/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedVirtualElements" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v2/data/VDAssociatedVirtualElements/15" rootUrl="https://10.64.80.159/webacs/api/v2/data">
<entity dtoType="vDAssociatedVirtualElementsDTO" type="VDAssociatedVirtualElements" url="https://10.64.80.159/webacs/api/v2/data/VDAssociatedVirtualElements/15">
<vdAssociatedVirtualElementsDTO displayName="String value" id="15" uuid="String value">
<clusterId>15</clusterId>
<clusterName>String value</clusterName>
<datacenterId>15</datacenterId>
<datacenterName>String value</datacenterName>
<discoverySource>String value</discoverySource>
<ipAddress>String value</ipAddress>
<name>String value</name>
<parentId>2</parentId>
<type>String value</type>
</vdAssociatedVirtualElementsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.80.159/webacs/api/v2/data/VDAssociatedVirtualElements/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedVirtualElements",
"@requestUrl" : "https://10.64.80.159/webacs/api/v2/data/VDAssociatedVirtualElements/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.80.159/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "vDAssociatedVirtualElementsDTO",
"@type" : "VDAssociatedVirtualElements",
"@url" : "https://10.64.80.159/webacs/api/v2/data/VDAssociatedVirtualElements/15",
"vdAssociatedVirtualElementsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"clusterId" : 15,
"clusterName" : "String value",
"datacenterId" : 15,
"datacenterName" : "String value",
"discoverySource" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"parentId" : 2,
"type" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/VDAssociatedVirtualElements
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
clusterId
Long
|
Id of the cluster this Virtual Element belongs to
|
clusterName
String
|
Name of the cluster this Virtual Element belongs to
|
datacenterId
Long
|
Id of the datacenter this Virtual Element belongs to
|
datacenterName
String
|
Name of the datacenter this Virtual Element belongs to
|
discoverySource
String
|
Virtual Element discovery source
|
ipAddress
String
|
Virtual Element IP address
|
name
String
|
|
parentId
long
|
Id of the parent Virtual Element
|
type
String
|
Virtual Element type (Datacenter, Cluster, Host)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.64.80.159/webacs/api/v3/data/VDAssociatedVirtualElements/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedVirtualElements" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v3/data/VDAssociatedVirtualElements/15" rootUrl="https://10.64.80.159/webacs/api/v3/data">
<entity dtoType="vDAssociatedVirtualElementsDTO" type="VDAssociatedVirtualElements" url="https://10.64.80.159/webacs/api/v3/data/VDAssociatedVirtualElements/15">
<vdAssociatedVirtualElementsDTO displayName="String value" id="15" uuid="String value">
<clusterId>15</clusterId>
<clusterName>String value</clusterName>
<datacenterId>15</datacenterId>
<datacenterName>String value</datacenterName>
<discoverySource>String value</discoverySource>
<ipAddress>String value</ipAddress>
<name>String value</name>
<parentId>2</parentId>
<type>String value</type>
</vdAssociatedVirtualElementsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.80.159/webacs/api/v3/data/VDAssociatedVirtualElements/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedVirtualElements",
"@requestUrl" : "https://10.64.80.159/webacs/api/v3/data/VDAssociatedVirtualElements/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.80.159/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "vDAssociatedVirtualElementsDTO",
"@type" : "VDAssociatedVirtualElements",
"@url" : "https://10.64.80.159/webacs/api/v3/data/VDAssociatedVirtualElements/15",
"vdAssociatedVirtualElementsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"clusterId" : 15,
"clusterName" : "String value",
"datacenterId" : 15,
"datacenterName" : "String value",
"discoverySource" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"parentId" : 2,
"type" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/VDAssociatedVirtualElements
To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
clusterId
Long
|
Id of the cluster this Virtual Element belongs to
|
clusterName
String
|
Name of the cluster this Virtual Element belongs to
|
datacenterId
Long
|
Id of the datacenter this Virtual Element belongs to
|
datacenterName
String
|
Name of the datacenter this Virtual Element belongs to
|
discoverySource
String
|
Virtual Element discovery source
|
ipAddress
String
|
Virtual Element IP address
|
name
String
|
|
parentId
long
|
Id of the parent Virtual Element
|
type
String
|
Virtual Element type (Datacenter, Cluster, Host)
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.64.80.159/webacs/api/v4/data/VDAssociatedVirtualElements/15
<?xml version="1.0" ?>
<queryResponse type="VDAssociatedVirtualElements" responseType="getEntity" requestUrl="https://10.64.80.159/webacs/api/v4/data/VDAssociatedVirtualElements/15" rootUrl="https://10.64.80.159/webacs/api/v4/data">
<entity dtoType="vDAssociatedVirtualElementsDTO" type="VDAssociatedVirtualElements" url="https://10.64.80.159/webacs/api/v4/data/VDAssociatedVirtualElements/15">
<vdAssociatedVirtualElementsDTO displayName="String value" id="15" uuid="String value">
<clusterId>15</clusterId>
<clusterName>String value</clusterName>
<datacenterId>15</datacenterId>
<datacenterName>String value</datacenterName>
<discoverySource>String value</discoverySource>
<ipAddress>String value</ipAddress>
<name>String value</name>
<parentId>2</parentId>
<type>String value</type>
</vdAssociatedVirtualElementsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.80.159/webacs/api/v4/data/VDAssociatedVirtualElements/15.json
{
"queryResponse" : {
"@type" : "VDAssociatedVirtualElements",
"@requestUrl" : "https://10.64.80.159/webacs/api/v4/data/VDAssociatedVirtualElements/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.64.80.159/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "vDAssociatedVirtualElementsDTO",
"@type" : "VDAssociatedVirtualElements",
"@url" : "https://10.64.80.159/webacs/api/v4/data/VDAssociatedVirtualElements/15",
"vdAssociatedVirtualElementsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"clusterId" : 15,
"clusterName" : "String value",
"datacenterId" : 15,
"datacenterName" : "String value",
"discoverySource" : "String value",
"ipAddress" : "String value",
"name" : "String value",
"parentId" : 2,
"type" : "String value"
}
} ]
}
}