SharedNetworkResource

This defines shared infrastructure resources that are created by user with CSPROOT role. These resources can be used by all the enterprises in the data center for various purposes. Examples of shared resources are public subnet, floating subnet, public L2 domain.

Overview

accessRestrictionEnabled boolean
address string required   filterable   orderable  
associatedPATMapperID string
backHaulRouteDistinguisher string filterable   orderable  
backHaulRouteTarget string filterable   orderable  
backHaulVNID integer filterable   orderable  
creationDate string read only   autogenerated   orderable  
description string filterable  
DHCPManaged boolean
domainRouteDistinguisher string filterable   orderable  
domainRouteTarget string filterable   orderable  
dynamicPATAllocationEnabled boolean
ECMPCount integer
embeddedMetadata list read only   autogenerated  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gateway string filterable   orderable  
gatewayMACAddress string filterable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
netmask string required   filterable   orderable  
owner string autogenerated  
permittedActionType enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE) filterable   orderable  
sharedResourceParentID string filterable   orderable  
subnetRouteDistinguisher string filterable   orderable  
subnetRouteTarget string filterable   orderable  
type enum (FLOATING | L2DOMAIN | PUBLIC | UPLINK_SUBNET) required   filterable   orderable  
underlay boolean filterable   orderable  
uplinkGWVlanAttachmentID string filterable   orderable  
uplinkInterfaceIP string
uplinkInterfaceMAC string
uplinkVPortName string
useGlobalMAC enum (DISABLED | ENABLED) filterable  
vnID integer filterable   orderable  

API Resource

/sharednetworkresources/id
delete get put

Parents

/enterprises/id/sharednetworkresources
get
/sharednetworkresources
get post
/patmappers/id/sharednetworkresources
get

Children

/sharednetworkresources/id/patipentries
get post
/sharednetworkresources/id/addressranges
get post
/sharednetworkresources/id/metadatas
get post
/sharednetworkresources/id/dhcpoptions
get post
/sharednetworkresources/id/globalmetadatas
get post put
/sharednetworkresources/id/enterprisepermissions
get post
/sharednetworkresources/id/vpnconnections
get post
/sharednetworkresources/id/staticroutes
get post

Members

This object has no members.

Attributes documentation

accessRestrictionEnabled boolean
Discussion

Boolean indicates that this shared network resource is avaiable to everyone by default or not

Charateristics

Format: free
SDK attribute: accessRestrictionEnabled

address string required   filterable   orderable  
Discussion

Address configured on the shared resource

Charateristics

Format: free
SDK attribute: address

associatedPATMapperID string
Discussion

The ID of the PatMapper entity to which this pool is associated to.

Charateristics

Format: free
SDK attribute: associatedPATMapperID

backHaulRouteDistinguisher string filterable   orderable  
Discussion

Backhaul route distinguisher of the shared resource. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]

Charateristics

Format: free
SDK attribute: backHaulRouteDistinguisher

backHaulRouteTarget string filterable   orderable  
Discussion

Backhaul route target of the shared resource. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]

Charateristics

Format: free
SDK attribute: backHaulRouteTarget

backHaulVNID integer filterable   orderable  
Discussion

Backhaul virtual network ID of the shared resource

Charateristics

SDK attribute: backHaulVNID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable  
Discussion

Description of the shared resource

Charateristics

Format: free
SDK attribute: description

DHCPManaged boolean
Discussion

true if DHCP is enabled else it is false. This value is always true for network resource of type PUBLIC or FLOATING.

Charateristics

Format: free
SDK attribute: DHCPManaged

domainRouteDistinguisher string filterable   orderable  
Discussion

Route distinguisher configured on the shared resource. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]

Charateristics

Format: free
SDK attribute: domainRouteDistinguisher

domainRouteTarget string filterable   orderable  
Discussion

Route target configured on the shared resource. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]

Charateristics

Format: free
SDK attribute: domainRouteTarget

dynamicPATAllocationEnabled boolean
Discussion

Indicates if PAT Mapping is enabled for the SharedNetworkResource or not

Charateristics

Format: free
SDK attribute: dynamicPATAllocationEnabled

ECMPCount integer
Discussion

Domain specific Equal-cost multi-path routing count, ECMPCount = 1 means no ECMP

Charateristics

Format: free
SDK attribute: ECMPCount

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

enterpriseID string
Discussion

Enterprise that this subnet belongs to

Charateristics

Format: free
SDK attribute: enterpriseID

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

gateway string filterable   orderable  
Discussion

Gatemask configured on the shared resource

Charateristics

Format: free
SDK attribute: gateway

gatewayMACAddress string filterable  
Discussion

MAC address for a public subnet or managed l2 domain

Charateristics

Format: free
SDK attribute: gatewayMACAddress

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

Name of the shared resource. Valid characters are alphabets, numbers, space and hyphen( - ).

Charateristics

Format: free
Min length: 1
Max length: 64
SDK attribute: name

netmask string required   filterable   orderable  
Discussion

Netmask configured on the shared resource

Charateristics

Format: free
SDK attribute: netmask

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

permittedActionType enum filterable   orderable  
Discussion

Permitted action on this shared network resource

Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
Format: free
SDK attribute: permittedActionType

sharedResourceParentID string filterable   orderable  
Discussion

Parent ID of the floating IP subnet to which this FIP subnet must be attached. If empty it will be created in a new domain.

Charateristics

Format: free
SDK attribute: sharedResourceParentID

subnetRouteDistinguisher string filterable   orderable  
Discussion

Route distinguisher configured on the shared resource subnetwork

Charateristics

Format: free
SDK attribute: subnetRouteDistinguisher

subnetRouteTarget string filterable   orderable  
Discussion

Route target configured on the shared resource subnetwork

Charateristics

Format: free
SDK attribute: subnetRouteTarget

type enum required   filterable   orderable  
Discussion

Type of the shared resource.

Charateristics

Allowed values: FLOATING, L2DOMAIN, PUBLIC, UPLINK_SUBNET
SDK attribute: type

underlay boolean filterable   orderable  
Discussion

Indicates whether this shared subnet is in underlay or not.

Charateristics

Format: free
SDK attribute: underlay

uplinkGWVlanAttachmentID string filterable   orderable  
Discussion

VLAN ID to which this vport must be attached

Charateristics

Format: free
SDK attribute: uplinkGWVlanAttachmentID

uplinkInterfaceIP string
Discussion

IP address of the host interface

Charateristics

Format: free
SDK attribute: uplinkInterfaceIP

uplinkInterfaceMAC string
Discussion

MAC address of the host interface

Charateristics

Format: free
SDK attribute: uplinkInterfaceMAC

uplinkVPortName string
Discussion

Name of the uplink vport

Charateristics

Format: free
SDK attribute: uplinkVPortName

useGlobalMAC enum filterable  
Discussion

if this flag is enabled, the system configured globalMACAddress will be used as the gateway mac address

Charateristics

Allowed values: DISABLED, ENABLED
SDK attribute: useGlobalMAC

vnID integer filterable   orderable  
Discussion

Virtual network ID of the shared resource

Charateristics

SDK attribute: vnID