Adding Distributed Firewall and Advanced Networking Services rights using the API in vCloud Director 8.20

search cancel

Adding Distributed Firewall and Advanced Networking Services rights using the API in vCloud Director 8.20

book

Article ID: 325611

calendar_today

Updated On:

Products

VMware Cloud Director

Issue/Introduction

This article provides steps to add rights to an organization which allow users to manage Distributed Firewalls and Advanced Networking Services in vCloud Director 8.20.

Symptoms:

Unable to manage Edge Gateway services after upgrading to Advance.
Cannot use the Manage Firewall functionality in vCloud Director 8.20.x

Environment

VMware Cloud Director for Service Provider 8.20.x

Resolution

To add Distributed Firewalls and Advanced Networking Services in vCloud Director 8.20:

Log in to the vCloud Director API.

Headers:

Authentication - Basic Authentication: (administrator@system, <administrator.password>)
Accept: application/*+xml;version=27.0
Content-type: application/*+xml

Create (POST) a session:

POST https://vCloud_FQDN/api/sessions

In the response headers, note the x-vcloud-authorization.
You must create a custom header, such as Accept and Content-Type, for x-vcloud-authorization and specify the value returned.
If this is not included, you are not Authorized to perform the actions.
Locate the API References for the Organizations you wish to Edit.

Headers:

Accept: application/*+xml;version=27.0
Content-type: application/*+xml
x-vcloud-authorization: <value from returned login request>

Note: Unless specified, the above headers are used for every Request

GET https:// vCloud_FQDN /api/admin

<OrganizationReferences>
<OrganizationReference href="https://vCloud_FQDN /api/admin/org/<ORG1_UUID>" name="Org1" type="application/vnd.vmware.admin.organization+xml"/>
<OrganizationReference href="https://vCloud_FQDN /api/admin/org/<ORG2_UUID>" name="Org2" type="application/vnd.vmware.admin.organization+xml"/>
<OrganizationReference href="https://vCloud_FQDN /api/admin/org/<ORG3_UUID>" name="Org3" type="application/vnd.vmware.admin.organization+xml"/>
<OrganizationReference href="https://vCloud_FQDN /api/admin/org/a93c9db9-7471-3192-8d09-a8f7eeda85f9" name="System" type="application/vnd.vmware.admin.organization+xml"/>
<OrganizationReference href="https://vCloud_FQDN /api/admin/org/<ORG4_UUID>" name="Org4" type="application/vnd.vmware.admin.organization+xml"/>
</OrganizationReferences>
Navigate to the Organization and navigate to the href appending /rights to the end:

GET https://vCloud_FQDN/api/admin/org/<ORG_UUID>/rights

Note: Replace the vCloud_FQDN with the FQDN of your vCloud Director.
Combine the existing rights with the additional rights below:

<RightReference href=" https://vCloud_FQDN/api/admin/right/a100f6a0-2c81-3b61-90c3-c4dbd721b3a8 " name="Organization vDC Distributed Firewall: Enable/Disable" type="application/vnd.vmware.admin.right+xml"/>

<RightReference href=" https://vCloud_FQDN/api/admin/right/2c4eb5ac-15f5-33f0-8b4a-680b3a1d3707 " name="Organization vDC Gateway: Configure BGP Routing" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/be1abe9a-7ddc-38f6-bdf3-94affb01e46b " name="Organization vDC Gateway: Configure DHCP" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/b755b050-772e-3c9c-9197-111c286f563d " name="Organization vDC Gateway: Configure Firewall" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/209cde55-55db-33f1-8357-b27bba6898ed " name="Organization vDC Gateway: Configure IPSec VPN" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/eeb2b2a0-33a1-36d4-a121-6547ad992d59 " name="Organization vDC Gateway: Configure L2 VPN" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/27be9828-4ce4-353e-8f68-5cd69260d94c " name="Organization vDC Gateway: Configure Load Balancer" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/c9e19573-3d54-3d4a-98f2-f56e446a8ef9 " name="Organization vDC Gateway: Configure NAT" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/3b337aef-42a8-3ed1-8616-341152bc5790 " name="Organization vDC Gateway: Configure OSPF Routing" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/72c5e652-c8d7-3f19-ab83-283d30cb679f " name="Organization vDC Gateway: Configure Remote Access" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/92b7d500-6bb6-3176-b9eb-d1fda4ce444d " name="Organization vDC Gateway: Configure SSL VPN" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/f72af304-97b0-379e-9d6d-68eb89bdc6cf " name="Organization vDC Gateway: Configure Static Routing" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/d9dabcab-579e-33c5-807b-dc9232bf7eff " name="Organization vDC Gateway: View BGP Routing" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/8e16d30d-1ae3-3fff-8d4b-64c342b186a9 " name="Organization vDC Gateway: View DHCP" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/7fee6646-ec0c-34c9-9585-aff6f4d92473 " name="Organization vDC Gateway: View Firewall" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/82beb471-ab7f-3e2b-a615-136ba6645525 " name="Organization vDC Gateway: View IPSec VPN" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/105191de-9e29-3495-a917-05fcb5ec1ad0 " name="Organization vDC Gateway: View L2 VPN" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/2a097e48-f4c4-3714-8b24-552b2d573754 " name="Organization vDC Gateway: View Load Balancer" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/fb860afe-2e15-3ca9-96d8-4435d1447732 " name="Organization vDC Gateway: View NAT" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/eb525145-08e5-3934-91ef-ec80837c9177 " name="Organization vDC Gateway: View OSPF Routing" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/65439584-6aad-3c2c-916f-794099ee85bf " name="Organization vDC Gateway: View Remote Access" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/cdb0edb0-9623-30a8-89de-b133db7cfeab " name="Organization vDC Gateway: View SSL VPN" type="application/vnd.vmware.admin.right+xml"/>
<RightReference href=" https://vCloud_FQDN/api/admin/right/9740be24-4dd7-373c-9237-91896338c11e " name="Organization vDC Gateway: View Static Routing" type="application/vnd.vmware.admin.right+xml"/>

For more information on the output, see the Additional Information section.
Update the Organization with the new list of Rights.

Place the XML in the Request Body and perform a PUT against the Organization:

PUT https://vCloud_FQDN/api/admin/org/<ORG_UUID>/rights
Update the Roles for the Organization that need access to these new rights:

For more information, see the Working With Roles and Rights section in the vCloud Director Administrator's Guide.

Additional Information

You see output similar to:

<?xml version="1.0" encoding="UTF-8"?>

<OrgRights xmlns="http://www.vmware.com/vcloud/v1.5" href="https://vCloud_FQDN/api/admin/org/<ORG_UUID>/rights" type="application/vnd.vmware.admin.org.rights+xml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://vCloud_FQDN/api/v1.5/schema/master.xsd">

</OrgRights>

Feedback

thumb_up Yes

thumb_down No