Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
Signed-off-by: Shawn Wang <wshaoquan@vmware.com>
  • Loading branch information
wsquan171 committed Dec 12, 2023
1 parent 2a616c1 commit e03f0e0
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
22 changes: 21 additions & 1 deletion website/docs/r/policy_user_management_role_binding.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ The following arguments are supported:
* `type` - (Required) Indicates the type of the user. Valid options:
* `remote_user` - This is a user which is external to NSX.
* `remote_group` - This is a group of users which is external to NSX.
* `local_user` - This is a user local to NSX. These are linux users. Note: Role bindings for local users are owned by NSX. Creation and deletion is not allowed for local users' binding. For updates, import existing bindings first.
* `local_user` - This is a user local to NSX. These are linux users. Note: Role bindings for local users are owned by NSX. Creation and deletion is not allowed for local users' binding. For updates, import existing bindings first. Alternatively, set `overwrite_local_user` to overwrite current role bindings with the one defined in terraform.
* `identity_source_type` - (Optional) Identity source type. Applicable only to `remote_user` and `remote_group` user types. Valid options are: `VIDM`, `LDAP`, `OIDC`, `CSP`. Defaults to `VIDM` when applicable.
* `identity_source_id` - (Optional) The ID of the external identity source that holds the referenced external entity. Currently, only external `LDAP` and `OIDC` servers are allowed.
* `roles_for_path` - (Required) A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
* `path` - (Required) Path of the entity in parent hierarchy.
* `roles` - (Required) A list of identifiers for the roles to associate with the given user limited to a path.
* `overwrite_local_user` - (Optional) Flag to allow overwriting existing role bindings for local user with terraform definition. On deletion, the user's role will be reverted to auditor only. Any exising configuration will be lost.

## Attributes Reference

Expand All @@ -56,6 +57,25 @@ In addition to arguments listed above, the following attributes are exported:
* `revision` - Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
* `user_id` - Local user's numeric id. Only applicable to `local_user`.

# Build-in NSX roles

`roles_for_path.roles` accepts user created roles as well as roles native to NSX. For reference, the following is a list of native roles as of NSX 4.1.2
- `network_engineer`: Network Admin
- `support_bundle_collector`: Support Bundle Collector
- `security_op`: Security Operator
- `lb_auditor`: LB Operator
- `netx_partner_admin`: NETX Partner Admin
- `project_admin`: Project Admin
- `auditor`: Auditor
- `network_op`: Network Operator
- `enterprise_admin`: Enterprise Admin
- `lb_admin`: LB Admin
- `gi_partner_admin`: GI Partner Admin
- `vpn_admin`: VPN Admin
- `vpc_admin`: VPC Admin
- `security_engineer`: Security Admin

The permission matrix for above roles is available on [NSX documentation](https://docs.vmware.com/en/VMware-NSX/4.1/administration/GUID-26C44DE8-1854-4B06-B6DA-A2FD426CDF44.html)

## Importing

Expand Down
19 changes: 19 additions & 0 deletions website/docs/r/principle_identity.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,25 @@ In addition to arguments listed above, the following attributes are exported:

* `certificate_id` - NSX certificate ID of the imported `certificate_pem`.

# Build-in NSX roles

`roles_for_path.roles` accepts user created roles as well as roles native to NSX. For reference, the following is a list of native roles as of NSX 4.1.2
- `network_engineer`: Network Admin
- `support_bundle_collector`: Support Bundle Collector
- `security_op`: Security Operator
- `lb_auditor`: LB Operator
- `netx_partner_admin`: NETX Partner Admin
- `project_admin`: Project Admin
- `auditor`: Auditor
- `network_op`: Network Operator
- `enterprise_admin`: Enterprise Admin
- `lb_admin`: LB Admin
- `gi_partner_admin`: GI Partner Admin
- `vpn_admin`: VPN Admin
- `vpc_admin`: VPC Admin
- `security_engineer`: Security Admin

The permission matrix for above roles is available on [NSX documentation](https://docs.vmware.com/en/VMware-NSX/4.1/administration/GUID-26C44DE8-1854-4B06-B6DA-A2FD426CDF44.html)

## Importing

Expand Down

0 comments on commit e03f0e0

Please sign in to comment.