Sample Exchange

This is a postman collection for interacting with the VeloCloud Ochestrator (VCO).

It allow users to import a CSV or JSON file, and use the values from the data file in the requests and scripts

An environment must be used including the following:

url is the target URL or IP of the VeloCloud Orchestrator
and at least 1 enterprise user:
ent-username is the enterprise admin user
nent-password is the enterprise admin password

A data file (csv for example) is also required with the following variables:

ProfileName, EdgeName, modelNumber, contactName, contactEmail, haEnabled

modelNumber can be: edge500, edge5X0, edge510, edge6x0, edge840, edge1000,, edge1000qat, edge3x00, edge3810,virtual

Ex:

EnterpriseName,ProfileName,EdgeName,modelNumber,contactName,contactEmail,haEnabled,GE3-cidrIp,GE3-cidrPrefix,GE3-netmask,GE3-gateway,GE3-vlanId,GE3-overlay,GE4-cidrIp,GE4-cidrPrefix,GE4-netmask,GE4-gateway,GE4-vlanId,GE4-overlay,name,contactPhone,contactMobile,streetAddress,streetAddress2,city,state,postalCode,country,lat,lon,timezone,locale,shippingSameAsLocation,shippingContactName,shippingAddress,shippingAddress2,shippingCity,shippingState,shippingPostalCode,shippingCountry
Customer-1,API-HUB-Profile,VCE1-H-API,Virtual,Vladimir,vladimir@vladimir.com,null,192.168.100.10,22,255.255.252.0,192.168.100.1,100,AUTO_DISCOVERED,192.168.200.10,22,255.255.252.0,192.168.200.1,,USER_DEFINED,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null
Customer-1,API-HUB-Profile,VCE2-H-API,Virtual,Vladimir,vladimir@vladimir.com,TRUE,192.168.101.11,24,255.255.255.0,192.168.101.1,,AUTO_DISCOVERED,192.168.201.11,24,255.255.255.0,192.168.201.1,201,USER_DEFINED,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null
Customer-1,API-Branches-Profile,VCE3-B-API,Virtual,Vladimir,vladimir@vladimir.com,null,192.168.102.12,24,255.255.255.0,192.168.102.1,102,AUTO_DISCOVERED,192.168.202.12,24,255.255.255.0,192.168.202.1,,USER_DEFINED,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null
Customer-1,API-Branches-Profile,VCE4-B-API,Virtual,Vladimir,vladimir@vladimir.com,null,192.168.103.13,24,255.255.255.0,192.168.103.1,,AUTO_DISCOVERED,192.168.203.13,24,255.255.255.0,192.168.203.1,,USER_DEFINED,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null
Customer-1,API-Branches-Profile,VCE5-B-API,Virtual,Vladimir,vladimir@vladimir.com,null,null,,,,,AUTO_DISCOVERED,null,,,,,USER_DEFINED,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null

This sample collection can do the following:

• Login to the VCO
• Retrieve the Enterprise ID
• Create a new Profile
• Modify the Profile vlan 1 (add a new IP)
• Add a Edge Access Firewall rule (using primary VCG tunnel IP)
• Provision Edges in a simple form

It can be used as a start learning point for more complex operations.

Note: Consistent with the disclaimer on the Sample Exchange home page, please note that vmware sdwan vco API and Support team - do not guarantee the samples; they are provided - AS IS - i.e. while we are glad to answer questions about API usage and behavior generally speaking, we cannot and do not specifically support these scripts.

However, please contact me if you see any issues or have any questions :) Vladimir F. de Sousa (vfrancadesou@vmware.com)

The following video has a walk through on how to go about using this collection:

https://youtu.be/AG_P766q4bU

Note: collection has been updated and confirmed to work on latest 5.1 version

1. ddddddIt allow users to import a dddd or JSON file, and use the values from the data file in the requests and scripts<\/li>\r\n<\/ol>\r\n\r\n
    <\/div>\r\n\r\n

   An environment must be used including the following:<\/div>\r\n\r\n

   url is the target URL or IP of the VeloCloud Orchestrator<\/div>\r\n\r\n

   and at least 1 type of user:<\/div>\r\n\r\n

   op-username is the operator admin username<\/div>\r\n\r\n

   op-password is the operator adminpassword<\/div>\r\n\r\n

   ent-username is the enterprise adminuser<\/div>\r\n\r\n

   ent-password is the enterprise admin password<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   A data file is also required with the following variables:<\/div>\r\n\r\n

   EnterpriseName <\/span>ProfileName <\/span>EdgeName modelNumber contactName contactEmail haEnabled<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   modelNumber can be: edge500, edge5X0, edge510, edge840, edge1000, edge1000qat, virtual<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   This sample collection can do the following:<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   Login to the VCO<\/div>\r\n\r\n

   Retrieve the Enterprise ID<\/div>\r\n\r\n

   Create a new Profile<\/div>\r\n\r\n

   Modify the Profile vlan 1<\/div>\r\n\r\n

   Add a Edge Access Firewall rule<\/div>\r\n\r\n

   Provision Edges<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   It can be used as a start point for more complex operations.<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   Vladimir F. de Sousa (vfrancadesou@vmware.com)<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   It allow users to import a CSV or JSON file, and use the values from the data file in the requests and scripts<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   An environment must be used including the following:<\/div>\r\n\r\n

   url is the target URL or IP of the VeloCloud Orchestrator<\/div>\r\n\r\n

   and at least 1 type of user:<\/div>\r\n\r\n

   op-username is the operator admin username<\/div>\r\n\r\n

   op-password is the operator adminpassword<\/div>\r\n\r\n

   ent-username is the enterprise adminuser<\/div>\r\n\r\n

   ent-password is the enterprise admin password<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   A data file is also required with the following variables:<\/div>\r\n\r\n

   EnterpriseName    ProfileName    EdgeName modelNumber contactName contactEmail haEnabled<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   modelNumber can be: edge500, edge5X0, edge510, edge840, edge1000, edge1000qat, virtual<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   This sample collection can do the following:<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   Login to the VCO<\/div>\r\n\r\n

   Retrieve the Enterprise ID<\/div>\r\n\r\n

   Create a new Profile<\/div>\r\n\r\n

   Modify the Profile vlan 1<\/div>\r\n\r\n

   Add a Edge Access Firewall rule<\/div>\r\n\r\n

   Provision Edges<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   It can be used as a start point for more complex operations.<\/div>\r\n\r\n

    <\/div>\r\n\r\n

   Vladimir F. de Sousa (vfrancadesou@vmware.com)<\/div>\r\n\r\n

    <\/div>\r\n