Enterprise Generate Nsd Via Edge Service Configuration

Enterprise Generate Nsd Via Edge Service Configuration

Get default service data for the backend API user

Privileges required:

CREATE NETWORK_SERVICE

Request
URI
POST
https://{api_host}/portal/rest/enterprise/generateNsdViaEdgeServiceConfiguration
COPY
Request Body

Show optional properties

{
    "provider": "string"
}
{
    "provider": "string",
    "enterpriseId": 0
}
string
provider
Required

provider

Possible values are : genericIKEv2Router, genericIKEv1Router, microsoftAzureVirtualWan, Zscaler, genericGRE, AWSTransitGateway, sse,
integer
enterpriseId
Optional

enterpriseId

Responses
200

Request was successfully processed

Returns nvs_from_edge_service_provider_data of type(s) application/json 
{
    "enabled": false,
    "provider": "string",
    "type": "string",
    "typeAlias": "string",
    "tunnelMode": "string",
    "automateDeployment": false,
    "iaasProvider": {
        "subscriptionObjectLogicalId": "string",
        "vendorSpecificData": {}
    },
    "providerCategory": "string",
    "routingPolicy": "string",
    "tunnelingProtocol": "string",
    "sharedIkeAuth": false,
    "sourceSubnets": {
        "subnets": [
            {
                "advertise": false,
                "cidrIp": "string",
                "metric": 0,
                "name": "string",
                "cidrPrefix": "string",
                "netMask": "string"
            }
        ]
    },
    "peerSubnets": {
        "alwaysReachable": false,
        "subnets": [
            {
                "advertise": false,
                "cidrIp": "string",
                "metric": 0,
                "name": "string",
                "cidrPrefix": "string",
                "netMask": "string"
            }
        ],
        "version": "string"
    },
    "bgp": {
        "enabled": false
    },
    "primaryServer": {
        "IKEPROP": {
            "DHGroup": 0,
            "PFS": 0,
            "authenticationAlgorithm": "string",
            "authenticationMethod": "string",
            "dpdTimeoutSeconds": 0,
            "encryptionAlgorithm": "string",
            "ikev1MainMode": false,
            "lifeTimeSeconds": 0,
            "peerIkeId": {
                "ikeId": "string",
                "ikeIdType": "string"
            },
            "protocolVersion": 0
        },
        "IPSECPROP": {
            "authenticationAlgorithm": "string",
            "encryptionAlgorithm": "string",
            "ipsecTunnelType": "string",
            "lifeTimeSeconds": 0,
            "reKeyTimer": 0,
            "protocol": "string",
            "dpdTimeoutSeconds": 0,
            "dpdType": "string"
        },
        "localLinkIp": "string",
        "nvsPublicIp": "string",
        "peerLinkIp": "string"
    },
    "backupServer": {
        "IKEPROP": {
            "DHGroup": 0,
            "PFS": 0,
            "authenticationAlgorithm": "string",
            "authenticationMethod": "string",
            "dpdTimeoutSeconds": 0,
            "encryptionAlgorithm": "string",
            "ikev1MainMode": false,
            "lifeTimeSeconds": 0,
            "peerIkeId": {
                "ikeId": "string",
                "ikeIdType": "string"
            },
            "protocolVersion": 0
        },
        "IPSECPROP": {
            "authenticationAlgorithm": "string",
            "encryptionAlgorithm": "string",
            "ipsecTunnelType": "string",
            "lifeTimeSeconds": 0,
            "reKeyTimer": 0,
            "protocol": "string",
            "dpdTimeoutSeconds": 0,
            "dpdType": "string"
        },
        "localLinkIp": "string",
        "nvsPublicIp": "string",
        "peerLinkIp": "string"
    },
    "keepBackupServerConnected": false,
    "version": "string"
}
boolean
enabled
Optional

enabled

string
provider
Optional

provider

Possible values are : genericIKEv2Router, genericIKEv1Router, microsoftAzureVirtualWan, Zscaler, genericGRE, AWSTransitGateway, sse,
string
type
Optional

type

Possible values are : genericIKEv2Router, genericIKEv1Router, microsoftAzureVirtualWan, Zscaler, genericGRE, AWSTransitGateway, sse,
string
typeAlias
Optional

typeAlias

string
tunnelMode
Optional

tunnelMode

Possible values are : ACTIVE_ACTIVE, ACTIVE_HOT_STANDBY, ACTIVE_STANDBY,
boolean
automateDeployment
Optional

automateDeployment

object
iaasProvider
Optional

iaasProvider

string
providerCategory
Optional

providerCategory

Possible values are : DATACENTER, CSS,
string
routingPolicy
Optional

routingPolicy

string
tunnelingProtocol
Optional

tunnelingProtocol

Possible values are : IPSEC, GRE,
boolean
sharedIkeAuth
Optional

sharedIkeAuth

object
sourceSubnets
Optional

sourceSubnets

object
peerSubnets
Optional

peerSubnets

object
bgp
Optional

bgp

object
primaryServer
Optional

primaryServer

object
backupServer
Optional

backupServer

boolean
keepBackupServerConnected
Optional

keepBackupServerConnected

string
version
Optional

version


400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"provider:"string"}' https://{api_host}/portal/rest/enterprise/generateNsdViaEdgeServiceConfiguration
On This Page
Enterprise Operations
POST
Add Enterprise Operator Configuration
POST
Enterprise Assign Enterprise Operator Configurations
POST
Enterprise Clone Enterprise V2
POST
Enterprise Decode Enterprise Key
POST
Enterprise Delete Object Group
POST
Enterprise Delete Security Object
POST
Enterprise Disable Cluster For Edge Hub
POST
Enterprise Enable Cluster For Edge Hub
POST
Enterprise Enable Secure Device Secrets For All Edges
POST
Enterprise Encode Enterprise Key
POST
Enterprise Generate Nsd Via Edge Service Configuration
POST
Enterprise Get Analytics Configuration
POST
Enterprise Get Enterprise
POST
Enterprise Get Enterprise Capabilities
POST
Enterprise Get Enterprise Distributed Cost Calculation
POST
Enterprise Get Enterprise Edges
POST
Enterprise Get Enterprise Gateway Handoff
POST
Enterprise Get Enterprise Maximum Segments
POST
Enterprise Get Enterprise Network Allocation
POST
Enterprise Get Enterprise Property
POST
Enterprise Get Enterprise Rate Limits
POST
Enterprise Get Use Nsd Policy
POST
Enterprise Get Enterprises With Property
POST
Enterprise Update Nsd Bgp Configuration
POST
Enterprise Get Object Groups
POST
Enterprise Get Security Objects
POST
Enterprise Insert Enterprise
POST
Enterprise Insert Enterprise Edge Cluster
POST
Enterprise Insert Enterprise Network Allocation
POST
Enterprise Insert Enterprise Network Segment
POST
Enterprise Insert Object Group
POST
Enterprise Insert Or Update Analytics Configuration
POST
Enterprise Insert Or Update Enterprise Capability
POST
Enterprise Insert Or Update Enterprise Gateway Handoff
POST
Enterprise Insert Or Update Enterprise Property
POST
Enterprise Insert Or Update Enterprise Specific Rate Limits
POST
Enterprise Insert Security Object
POST
Enterprise Is Enterprise Upgraded Later Than
POST
Enterprise Set Enterprise Refresh Routes Version
POST
Set Default Enterprise Operator Configuration
POST
Enterprise Set Bastion State
POST
Enterprise Set Enterprise Distributed Cost Calculation
POST
Enterprise Set Enterprise Maximum Segments
POST
Enterprise Set Nsd Buckets Flag
POST
Enterprise Update Enterprise
POST
Enterprise Update Enterprise Edge Cluster
POST
Enterprise Update Enterprise Network Allocation
POST
Enterprise Update Enterprise Network Segment
POST
Enterprise Update Enterprise Security Policy
POST
Enterprise Update Object Group
POST
Enterprise Update Security Object
POST
Enterprise Proxy Get Enterprise Proxy Enterprises With Property
POST
Get Enterprise Gateway Route Table Config