EFA RBAC Policy Enforcement

EFA implements an RBAC (Role-based Access Control) policy governing access to northbound REST APIs.

The RBAC policy is enforced at the northbound interface, immediately after validation of the access token. An error message is returned if an RBAC permissions check fails.

RBAC and REST URI matrix

The RBAC policy is expressed in a permissions matrix indexed by RBAC role and REST URI, in which each matrix element enumerates the permitted HTTP methods.

Table 1. RBAC and REST matrix
Role A Role B Role C
REST URI 1 GET GET GET, POST, PUT, PATCH, DELETE
REST URI 2 GET, POST GET, POST, PUT GET, POST, PUT, PATCH, DELETE
REST URI 3 GET, POST GET, POST GET, POST, PUT, PATCH, DELETE

RBAC roles

Roles can be populated into the upstream LDAP instance.

Table 2. Role definitions
Role Description
FabricAdmin
  • Registers devices to the Fabric
  • Configures Fabric parameters
  • Validates all devices in the Fabric
  • Configures switches for IP Fabric with overlay and without overlay
  • Creates tenants
  • Creates networks inside tenants, such as VRF, EPG, and PO
  • Performs Fabric debug activities
  • Has privileges for OpenStack, Hyper-V, and vCenter operations
SecurityAdmin Performs user management, PKI, and key management operations
NetworkOperator
  • Has view-only privileges for Fabric configurations, information for tenants and inventory, and all ecosystem information
  • Cannot make changes in the system
SystemDebugger
  • Has privileges to perform supportsave and system backup, and to view the running system configurations
  • Has privileges to perform Fabric debug operations
  • Sets debug levels for services
  • Has privileges to collect execution logs from services
SystemAdmin Has complete privileges to all operations in the system
<Tenant>Admin

* Created dynamically per tenant

Performs tenant administration within the assigned tenant, such as the following:
  • Adding networks to the tenant
  • Configuring network parameters
  • Configuring switches with tenant-specific information
Cannot perform actions for any other tenant

* Tenant Administrator roles are added dynamically to the system when a tenant is created. The name of the role is of the format <Tenant-name>Admin. For example, if a tenant with the name “RegionOne” is created, the role created for the Tenant Administrator is “RegionOneAdmin”.

Note

Note

You cannot create custom roles.

Role permissions

Allowed Privileges System Admin Fabric Admin Tenant Admin Network Operator Security Admin System Debugger
Create/Clone/Delete Fabric in the system
Register/Unregister devices in Fabric, Configure IP Fabric on the device
Show IP Fabric physical/underlay/ overlay topology, IP fabric configs and devices in IP Fabric
Debug Fabric operations
Inventory/Asset service operations
Execute CLI access on the device
Create/Delete/Update tenants
Create/Delete EPG, PO, VRFs inside tenant
Add/Remove Port/Port Channels to/from EPG
Add/Remove Network Policies to EPG
Detach Network from EPG
Identify drift in device configuration
Set tenant debug level
Show OpenStack networks, PO, subnets, tenant, ports, router, router-interface
Create/Delete/Cleanup OpenStack Networks
Create/Delete OpenStack Subnets
Create/Delete OpenStack Ports
Create/Delete OpenStack Router
Create/Delete Router Interfaces
Delete OpenStack asset (DebugDeleteOSSAsset)
View vCenter Details, events, ESXI details, Physical links, Virtual Links, Disconnected links, Get server settings etc
Register/Delete/Update vCenter
Set vCenter debug level
Update vCenter polling frequency, dead link clearing time
View SCVMM server details, Service Settings, Physical Links, Virtual Links
Register/Delete/Update SCVMM server
Update SCVMM server polling frequency
User Management, assign roles to users, configure LDAP, view available roles in the system
Notification service (Add/Delete subscribers)
Execution Log View

(Only Tenant)

(Only Auth and RBAC)

Support Save Collection
Backup and Restore Operation

(Only backup)

Install certificates