Cisco Cisco Prime IP Express 8.3 テクニカルリファレンス

ページ / 1286
Resource: VPN
This resource is used to manage the 
 class of Network Registrar objects.
A VPN. A VPN is used to support VPN-aware DHCP and address-space management.
Functions
Get VPN Object List
Gets the list of Network Registrar VPN objects.
Request:
GET /web-services/rest/resource/VPN 
VPN string properties may be specified as query parameters to filter the return list. Filter values
can specify a regular expression or exact match. Use an empty string to test for unset values.
Response:
Returns the list of VPN objects
Content-Type: application/xml, application/json
If the list exceeds the maximum return list size, the next link is provided to get the next set of
objects.
Get VPN Object By Name
Gets the Network Registrar VPN object by name.
Request:
GET /web-services/rest/resource/VPN/{objectName}
objectName
: the string representation of the VPN name property
Response:
Returns the VPN object
Content-Type: application/xml, application/json
Put VPN Object By Name
Modifies or creates the specified Network Registrar VPN object.
Request:
PUT /web-services/rest/resource/VPN/{objectName} 
Accept: application/xml, application/json 
objectName: the string representation of the VPN name property 
Query Parameters 
  action: extra action to perform; value can be 'push' 
When connected to a regional server, the optional push action will push the object to the
specified local clusters after changes are made. If the input object is null, or identical to the
currently saved object, only the push action will be performed. 
Action Parameters 
  localCluster: the cluster or pair name; use repeated parameters or a comma-separated list to
specify a multiple entries 
  mode: the sync mode; value can be 'ensure', 'replace', or 'exact' 
At least one local cluster or pair must be specified. By default, changes will be made in 'replace'
mode.
Response:
Returns the location of the VPN object, if created
Content: none
Create VPN Object