Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
ContentIndex
  
[+] Expand All
[-] Collapse All

Object Builder RESTful Web Services

The following operations can be performed using the Edge Services Director Object Builder RESTful Web Services.

Get Object Builder Statistics

This request is used to retrieve the statistical details related to the object builder. The objects are the constituents or building blocks that are used to create service definitions and policy or filter templates. You can use the object builder to retrieve and transfer the objects or components that have been previously created on the SDGs or device.

URI

/api/sgd/configmanager/sdgobjectbuilder/objectbuilderstatistics

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.objectbuilderstatistics+json;
version=1;charset=UTF-8

Consumes

None

Produces

Collects the object builder statistics

Response Status Code

Message

Description

200 OK

Successful collection of object builder statistics

Output

Sample JSON Output

 
[
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "RealServers",
      "total": 540,
      "unused": 540,
      "used": 0
    }
  },
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "CGNATPool",
      "total": 6,
      "unused": 6,
      "used": 0
    }
  },
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "CGNATRules",
      "total": 5,
      "unused": 5,
      "used": 0
    }
  },
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "CGNATRuleSets",
      "total": 0,
      "unused": 0,
      "used": 0
    }
  },
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "SFWRules",
      "total": 3,
      "unused": 3,
      "used": 0
    }
  },
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "SFWRuleSets",
      "total": 1,
      "unused": 1,
      "used": 0
    }
  },
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "Applications",
      "total": 91,
      "unused": 91,
      "used": 0
    }
  },
  {
    "ObjectBuilderUsedStatisticTO": {
      "name": "ApplicationSets",
      "total": 5,
      "unused": 5,
      "used": 0
    }
  }
]

Import Object Builder Data from SDG Hosts

This request is used to retrieve the objects that were previously created on the SDG devices and import all object definitions to the Edge Services Director database.

URI

/api/sgd/configmanager/sdgobjectbuilder/
uploadExistingConfigurationXML/{sdgHostName}

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.uploadExistingConfigurationXML/
{sdgHostName}+json;version=1;charset=UTF-8

Consumes

None

Produces

Import all object definitions defined on an SDG device into Edge Services Director

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Clear Object Builder Data from SDG Hosts

This request is used to remove all the object definitions that were imported to the Edge Services Director repository.

URI

/api/sgd/configmanager/sdgobjectbuilder/deleteObjectBuilder

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.deleteObjectBuilder+json;
version=1;charset=UTF-8

Consumes

None

Produces

Delete all the imported objects from Edge Services Director

Response Status Code

Message

Description

204 No Content

The server fulfilled the request, but does not need to return a response message body.

Get Real Server Objects From Object Builders

This request is used to retrieve the real server objects that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getRealServers?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getRealServers?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the real server objects that were imported

Response Status Code

Message

Description

200 OK

Successful collection of real server objects

Output

Sample JSON Output

{ "response" : { "data" : [ { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69561",
            "address" : "172.17.37.50",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:58+05:30",
            "id" : 69561,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:58+05:30",
            "name" : "DNS1",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69560",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:58+05:30",
                "healthCheckInterval" : 3,
                "id" : 69560,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:58+05:30",
                "name" : "DNS1",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69563",
            "address" : "172.17.37.51",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:58+05:30",
            "id" : 69563,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:58+05:30",
            "name" : "DNS2",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69562",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:58+05:30",
                "healthCheckInterval" : 2,
                "id" : 69562,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:58+05:30",
                "name" : "DNS2",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69565",
            "address" : "172.17.37.52",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:58+05:30",
            "id" : 69565,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:58+05:30",
            "name" : "DNS3",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69564",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:58+05:30",
                "healthCheckInterval" : 2,
                "id" : 69564,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:58+05:30",
                "name" : "DNS3",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69567",
            "address" : "172.17.37.53",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:58+05:30",
            "id" : 69567,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:58+05:30",
            "name" : "DNS4",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69566",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:58+05:30",
                "healthCheckInterval" : 2,
                "id" : 69566,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:58+05:30",
                "name" : "DNS4",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69569",
            "address" : "172.17.37.54",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:58+05:30",
            "id" : 69569,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:58+05:30",
            "name" : "DNS5",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69568",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:58+05:30",
                "healthCheckInterval" : 2,
                "id" : 69568,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:58+05:30",
                "name" : "DNS5",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69571",
            "address" : "172.17.37.55",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:58+05:30",
            "id" : 69571,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:58+05:30",
            "name" : "DNS6",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69570",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:58+05:30",
                "healthCheckInterval" : 2,
                "id" : 69570,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:58+05:30",
                "name" : "DNS6",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69573",
            "address" : "172.17.37.56",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69573,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "DNS7",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69572",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:59+05:30",
                "healthCheckInterval" : 2,
                "id" : 69572,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:59+05:30",
                "name" : "DNS7",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69575",
            "address" : "172.17.39.50",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69575,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS01",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerHealthCheck" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerHealthCheckEntity_$$_javassist_472:69574",
                "createdBy" : "super",
                "createdTime" : "2014-11-18T10:54:59+05:30",
                "healthCheckInterval" : 2,
                "id" : 69574,
                "modifiedBy" : "super",
                "modifiedTime" : "2014-11-18T10:54:59+05:30",
                "name" : "MSP01TS01",
                "recoveryRetries" : 1
              },
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69576",
            "address" : "172.17.39.51",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69576,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS02",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69577",
            "address" : "172.17.39.52",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69577,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS03",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69578",
            "address" : "172.17.39.53",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69578,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS04",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69579",
            "address" : "172.17.39.54",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69579,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS05",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69580",
            "address" : "172.17.39.55",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69580,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS06",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69581",
            "address" : "172.17.39.56",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69581,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS07",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69582",
            "address" : "172.17.39.57",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69582,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS08",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69583",
            "address" : "172.17.39.58",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69583,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS09",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69584",
            "address" : "172.17.39.59",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69584,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS10",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69585",
            "address" : "172.17.39.60",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69585,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP01TS11",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69586",
            "address" : "172.17.39.61",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69586,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS01",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69587",
            "address" : "172.17.39.62",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69587,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS02",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69588",
            "address" : "172.17.39.63",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69588,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS03",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69589",
            "address" : "172.17.39.64",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69589,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS04",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69590",
            "address" : "172.17.39.65",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69590,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS05",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69591",
            "address" : "172.17.39.66",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69591,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS06",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69592",
            "address" : "172.17.39.67",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69592,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS07",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69593",
            "address" : "172.17.39.68",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69593,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS08",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69594",
            "address" : "172.17.39.69",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69594,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS09",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69595",
            "address" : "172.17.39.70",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69595,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS10",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69596",
            "address" : "172.17.39.71",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69596,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP02TS11",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.RealServerEntity:69597",
            "address" : "172.17.39.72",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:59+05:30",
            "id" : 69597,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:59+05:30",
            "name" : "MSP03TS01",
            "objectCreateType" : "OBJECTBUILDER",
            "realServerType" : "ADC",
            "type" : "IPv4"
          }
        ],
      "success" : true,
      "totalRows" : 540
    } }

Get CGNAT Rules From Object Builders

This request is used to retrieve the CGNAT rule objects that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getCGNATRules?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getCGNATRules?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the CGNAT rule objects that were imported

Response Status Code

Message

Description

200 OK

Successful collection of CGNAT rule objects

Output

Sample JSON Output

{ "response" : { "data" : [ { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATRuleEntity:69543",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 69543,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : "napt44-SS1-r1",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATRuleEntity:69545",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 69545,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : "napt44-SS2-r1",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATRuleEntity:69549",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 69549,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : "napt44-SS3-r1",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATRuleEntity:69553",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 69553,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : "napt44-SS4-r1",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATRuleEntity:69557",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 69557,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : 111,
            "objectCreateType" : "OBJECTBUILDER"
          }
        ],
      "success" : true,
      "totalRows" : 5
    } }

Get CGNAT Rule Sets From Object Builders

This request is used to retrieve the CGNAT rule set objects that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getCGNATRuleSets?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getCGNATRuleSets?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the CGNAT rule set objects that were imported

Response Status Code

Message

Description

200 OK

Successful collection of CGNAT rule set objects

Output

Sample JSON Output

{
  "response": {
    "success": true,
    "totalRows": 0
  }
}

Get CGNAT Pools From Object Builders

This request is used to retrieve the CGNAT pools that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getCGNATPools?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getCGNATPools?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the CGNAT pools that were imported

Response Status Code

Message

Description

200 OK

Successful collection of CGNAT pools

Output

Sample JSON Output

{
   "response":{
      "success":true,
      "totalRows":6,
      "data":[
         {
            "id":69517,
            "MOID":"net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATPoolEntity:69517",
            "createdBy":"super",
            "modifiedBy":"super",
            "createdTime":"2014-11-18T10:55:08+05:30",
            "modifiedTime":"2014-11-18T10:55:08+05:30",
            "name":"napt44-SS1-p1",
            "objectCreateType":"OBJECTBUILDER"
         },
         {
            "id":69522,
            "MOID":"net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATPoolEntity:69522",
            "createdBy":"super",
            "modifiedBy":"super",
            "createdTime":"2014-11-18T10:55:08+05:30",
            "modifiedTime":"2014-11-18T10:55:08+05:30",
            "name":"napt44-SS2-p1",
            "objectCreateType":"OBJECTBUILDER"
         },
         {
            "id":69527,
            "MOID":"net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATPoolEntity:69527",
            "createdBy":"super",
            "modifiedBy":"super",
            "createdTime":"2014-11-18T10:55:08+05:30",
            "modifiedTime":"2014-11-18T10:55:08+05:30",
            "name":"napt44-SS3-p1",
            "objectCreateType":"OBJECTBUILDER"
         },
         {
            "id":69532,
            "MOID":"net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATPoolEntity:69532",
            "createdBy":"super",
            "modifiedBy":"super",
            "createdTime":"2014-11-18T10:55:08+05:30",
            "modifiedTime":"2014-11-18T10:55:08+05:30",
            "name":"napt44-SS4-p1",
            "objectCreateType":"OBJECTBUILDER"
         },
         {
            "id":69536,
            "MOID":"net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATPoolEntity:69536",
            "createdBy":"super",
            "modifiedBy":"super",
            "createdTime":"2014-11-18T10:55:08+05:30",
            "modifiedTime":"2014-11-18T10:55:08+05:30",
            "name":"testnat",
            "objectCreateType":"OBJECTBUILDER"
         },
         {
            "id":69539,
            "MOID":"net.juniper.jmp.sgd.configmanager.config.jpa.cgnat.CGNATPoolEntity:69539",
            "createdBy":"super",
            "modifiedBy":"super",
            "createdTime":"2014-11-18T10:55:08+05:30",
            "modifiedTime":"2014-11-18T10:55:08+05:30",
            "name":"new-nat-pool",
            "objectCreateType":"OBJECTBUILDER"
         }
      ]
   }
}

Get Stateful Firewall Rules From Object Builders

This request is used to retrieve the stateful firewall (SFW) rules that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getSFWRules?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getSFWRules?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the SFW rule objects that were imported

Response Status Code

Message

Description

200 OK

Successful collection of SFW rule objects

Output

Sample JSON Output

{ "response" : { "data" : [ { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.sfw.SFWRuleEntity:70108",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 70108,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : "rtsp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.sfw.SFWRuleEntity:70110",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 70110,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : "IPv6-SFW",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.sfw.SFWRuleEntity:70114",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:55:08+05:30",
            "id" : 70114,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:55:08+05:30",
            "name" : "TEST_RULE",
            "objectCreateType" : "OBJECTBUILDER"
          }
        ],
      "success" : true,
      "totalRows" : 3
    } }

Get Stateful Firewall Rule Sets From Object Builders

This request is used to retrieve the SFW rule set objects that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getSFWRuleSets?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getSFWRuleSets?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the SFW rule set objects that were imported

Response Status Code

Message

Description

200 OK

Successful collection of SFW rule set objects

Output

Sample JSON Output

{ "response" : { "data" : { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.sfw.SFWRuleSetEntity:70122",
          "createdBy" : "super",
          "createdTime" : "2014-11-18T10:55:08+05:30",
          "id" : 70122,
          "modifiedBy" : "super",
          "modifiedTime" : "2014-11-18T10:55:08+05:30",
          "name" : "aaa",
          "objectCreateType" : "OBJECTBUILDER"
        },
      "success" : true,
      "totalRows" : 1
    } }

Get Applications From Object Builders

This request is used to retrieve the applications that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getApplications?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getApplications?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the applications that were imported

Response Status Code

Message

Description

200 OK

Successful collection of applications

Output

Sample JSON Output

{ "response" : { "data" : [ { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65540",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65540,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dcerpc-msexchange-directory-nsp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65541",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65541,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dcerpc-msexchange-information-store",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65542",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65542,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dcerpc-msexchange-directory-rfr",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65543",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65543,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dcerpc",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65544",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65544,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dcerpc-endpoint-mapper-service",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65545",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65545,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dce-rpc-portmap",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65547",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65547,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-pptp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65549",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65549,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dns-tcp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65551",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65551,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-dns-udp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65553",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65553,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-rsh",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65555",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65555,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-rpc-services-tcp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65556",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65556,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-rpc-services-udp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65557",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65557,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-rpc-portmap-udp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65559",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65559,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-rpc-portmap-tcp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65561",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65561,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-realaudio",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65563",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65563,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-ip",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65564",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65564,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-ipsec-esp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65565",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65565,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-sqlnet",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65567",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65567,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-sip",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65569",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65569,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-traceroute-ttl-1",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65571",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65571,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-traceroute",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65573",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65573,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-rlogin",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65575",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65575,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-rexec",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65577",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65577,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-ntalk",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65579",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65579,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-talk-udp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65581",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65581,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-talk-tcp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65583",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65583,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-netbios-datagram",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65585",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65585,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-netbios-name-tcp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65587",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65587,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-netbios-name-udp",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationEntity:65589",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65589,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-netshow",
            "objectCreateType" : "OBJECTBUILDER"
          }
        ],
      "success" : true,
      "totalRows" : 91
    } }

Get Application Sets From Object Builders

This request is used to retrieve the application sets that were previously imported to the object builder.

URI

/api/sgd/configmanager/sdgobjectbuilder/
getApplicationSets?page=1&start=0&limit=30

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.configmanager
sdgobjectbuilder.getApplicationSets?page=1&start=0
&limit=30+json;version=1;charset=UTF-8

Consumes

None

Produces

Collects the application sets that were imported

Response Status Code

Message

Description

200 OK

Successful collection of application sets

Output

Sample JSON Output

{ "response" : { "data" : [ { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationSetEntity:65693",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65693,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-algs-outbound",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationSetEntity:65694",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65694,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-management-inbound",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationSetEntity:65695",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65695,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-cifs",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationSetEntity:65696",
            "createdTime" : "2014-11-17T14:12:12+05:30",
            "id" : 65696,
            "modifiedTime" : "2014-11-17T14:12:12+05:30",
            "name" : "junos-routing-inbound",
            "objectCreateType" : "OBJECTBUILDER"
          },
          { "MOID" : "net.juniper.jmp.sgd.configmanager.config.jpa.common.ApplicationSetEntity:69501",
            "createdBy" : "super",
            "createdTime" : "2014-11-18T10:54:58+05:30",
            "id" : 69501,
            "modifiedBy" : "super",
            "modifiedTime" : "2014-11-18T10:54:58+05:30",
            "name" : "SDG-APPS",
            "objectCreateType" : "OBJECTBUILDER"
          }
        ],
      "success" : true,
      "totalRows" : 5
    } }

Modified: 2016-08-02