[Index]
Model ref.: relation/HcsIOSDeviceREL
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "IOS Device Name",
"pattern": "^[A-Za-z0-9_\\- ]+$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"host": {
"is_password": false,
"title": "Host Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"localGw": {
"is_password": false,
"title": "Local Gateway Associated",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"analogGw": {
"is_password": false,
"title": "Analog Gateway Associated",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"ext": {
"title": "Ext",
"type": "object",
"properties": {
"host": {
"required": true,
"type": "string",
"description": "The host name of IOS device",
"title": "Host Name"
},
"description": {
"required": false,
"type": "string",
"description": "The description of the IOS device.",
"title": "Description"
},
"username": {
"required": false,
"type": "string",
"description": "The username for the device.",
"title": "Username"
},
"password": {
"is_password": true,
"description": "The password for the device.",
"title": "Password",
"required": false,
"store_encrypted": true,
"type": "string"
},
"enable_password": {
"is_password": true,
"description": "The enable password",
"title": "Enable Password",
"required": false,
"store_encrypted": true,
"type": "string"
},
"port": {
"type": "string",
"description": "The port of the IOS device.",
"title": "Port"
}
}
},
"cpe": {
"title": "Cpe",
"type": "object",
"properties": {
"id": {
"is_password": false,
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"isRouter": {
"is_password": false,
"title": "Is Router",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"isGateway": {
"is_password": false,
"title": "Is Gateway",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"isSRST": {
"is_password": false,
"title": "Is SRST",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"isMediaDevice": {
"is_password": false,
"title": "Is Media Device",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"isCubeEnterprise": {
"is_password": false,
"title": "Is Cube Enterprise",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 152,
"type": "string"
},
"cUOM": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"title": "CUOM",
"type": "string",
"target": "/api/data/HCSHcmfCUOMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCUOMDAT",
"choices": []
},
"cluster": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"title": "Cluster",
"type": "string",
"target": "/api/data/HCSHcmfClusterDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfClusterDAT",
"choices": []
},
"customerLocation": {
"is_password": false,
"format": "uri",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"title": "Customer Location",
"type": "string",
"target": "/api/data/HCSHcmfCustomerLocationDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCustomerLocationDAT",
"choices": []
},
"monitorsPrimeCollab": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"title": "Monitors Prime Collab",
"type": "string",
"target": "/api/data/HCSHcmfPrimeCollabDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfPrimeCollabDAT",
"choices": []
},
"credentials": {
"is_password": false,
"title": "Credentials",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"typeCredential": {
"is_password": false,
"title": "Type Credential",
"required": true,
"displayable": false,
"choices": [
{
"value": "SNMP_V1",
"title": "SNMP_V1"
},
{
"value": "SNMP_V2",
"title": "SNMP_V2"
},
{
"value": "SNMP_V3",
"title": "SNMP_V3"
},
{
"value": "ADMIN",
"title": "ADMIN"
},
{
"value": "PLATFORM",
"title": "PLATFORM"
},
{
"value": "WMI",
"title": "WMI"
},
{
"value": "IOS_ENABLE",
"title": "IOS_ENABLE"
},
{
"value": "HTTP",
"title": "HTTP"
},
{
"value": "CLI",
"title": "CLI"
},
{
"value": "OPERATOR",
"title": "OPERATOR"
},
{
"value": "SFTP",
"title": "SFTP"
},
{
"value": "JTAPI",
"title": "JTAPI"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"userID": {
"is_password": false,
"title": "User ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 256,
"type": "string"
},
"password_CommunityString": {
"is_password": true,
"title": "Password Community String",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 512,
"store_encrypted": true,
"type": "string"
},
"typeSNMPAccess": {
"is_password": false,
"title": "Type SNMP Access",
"default": "RO",
"required": false,
"displayable": false,
"choices": [
{
"value": "RO",
"title": "RO"
},
{
"value": "RW",
"title": "RW"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"networkAddresses": {
"is_password": false,
"title": "Network Addresses",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"typeAddressSpace": {
"is_password": false,
"title": "Type Address Space",
"required": true,
"displayable": false,
"choices": [
{
"value": "APPLICATION_SPACE",
"title": "APPLICATION_SPACE"
},
{
"value": "SERVICE_PROVIDER_SPACE",
"title": "SERVICE_PROVIDER_SPACE"
},
{
"value": "CUSTOMER_SPACE",
"title": "CUSTOMER_SPACE"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"iPAddrV4": {
"is_password": false,
"title": "IP Addr V4",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"iPAddrV6": {
"is_password": false,
"title": "IP Addr V6",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"hostShortNameOnly": {
"is_password": false,
"title": "Host Short Name Only",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"domain": {
"is_password": false,
"title": "Domain",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"isSRVAddress": {
"is_password": false,
"title": "Is SRV Address",
"default": false,
"required": true,
"displayable": false,
"readonly": false,
"type": "boolean"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"bkCustomer_shortName": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"target_attr": "shortName",
"readonly": false,
"maxLength": 1024,
"title": "Bk Customer Short Name",
"type": "string",
"target": "/api/data/HCSHcmfCustomerDAT/choices/?field=shortName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCustomerDAT",
"choices": []
},
"bkCustomerLocation_shortName": {
"is_password": false,
"format": "uri",
"required": false,
"displayable": false,
"target_attr": "shortName",
"readonly": false,
"maxLength": 1024,
"title": "Bk Customer Location Short Name",
"type": "string",
"target": "/api/data/HCSHcmfCustomerLocationDAT/choices/?field=shortName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCustomerLocationDAT",
"choices": []
}
}
}
},
"schema_version": "2.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsIOSDeviceREL/add/ |
|
The GUI Add form of relation/HcsIOSDeviceREL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/HcsIOSDeviceREL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsIOSDeviceREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsIOSDeviceREL/[pkid1]", "/api/relation/HcsIOSDeviceREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsIOSDeviceREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsIOSDeviceREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsIOSDeviceREL/export/ |
|
{ "hrefs":["/api/relation/HcsIOSDeviceREL/[pkid1]", "/api/relation/HcsIOSDeviceREL/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/HcsIOSDeviceREL and the JSON format can be used to import instances of relation/HcsIOSDeviceREL.
GET http://[host-proxy]/api/relation/HcsIOSDeviceREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsIOSDeviceREL | POST | /api/relation/HcsIOSDeviceREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsIOSDeviceREL/ |
|
The relation/HcsIOSDeviceREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsIOSDeviceREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/HcsIOSDeviceREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"update",
"help",
"remove",
"field_display_policy",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/HcsIOSDeviceREL",
"summary_attrs": [
{
"name": "name",
"title": "IOS Device Name"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsIOSDeviceREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"help",
"remove",
"add",
"export",
"list",
"get",
"export_bulkload_template"
],
"schema_version": "2.3",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsIOSDeviceREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsIOSDeviceREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsIOSDeviceREL/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/HcsIOSDeviceREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsIOSDeviceREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsIOSDeviceREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsIOSDeviceREL. | GET | /api/relation/HcsIOSDeviceREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsIOSDeviceREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsIOSDeviceREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsIOSDeviceREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsIOSDeviceREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsIOSDeviceREL/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/HcsIOSDeviceREL and the JSON format can be used to import instances of relation/HcsIOSDeviceREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsIOSDeviceREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsIOSDeviceREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsIOSDeviceREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsIOSDeviceREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Regenerate Ios Commands | POST | /api/relation/HcsIOSDeviceREL/[pkid]/+Regenerate_IOS_Commands | hierarchy=[hierarchy] | If payload required: |