vcf_vcenter_sso

Execution module for vCenter SSO identity management.

Wraps saltext.vcf.clients.vcenter_sso for identity provider, group, and user administration on vSphere 9 vCenter.

saltext.vcf.modules.vcf_vcenter_sso.providers_list(profile=None)

List identity providers.

CLI Example:

salt '*' vcf_vcenter_sso.providers_list

saltext.vcf.modules.vcf_vcenter_sso.providers_get(provider_id, profile=None)

Return a single identity provider by id.

CLI Example:

salt '*' vcf_vcenter_sso.providers_get <provider_id>

saltext.vcf.modules.vcf_vcenter_sso.providers_get_or_none(provider_id, profile=None)

Return the provider or None if missing.

CLI Example:

salt '*' vcf_vcenter_sso.providers_get_or_none <provider_id>

saltext.vcf.modules.vcf_vcenter_sso.providers_create(spec, profile=None)

Create an identity provider from spec.

CLI Example:

salt '*' vcf_vcenter_sso.providers_create spec='{"config_tag": "ActiveDirectory", "domain_name": "corp.example"}'

saltext.vcf.modules.vcf_vcenter_sso.providers_update(provider_id, spec, profile=None)

PATCH an identity provider.

CLI Example:

salt '*' vcf_vcenter_sso.providers_update <provider_id> spec='{"username": "svc"}'

saltext.vcf.modules.vcf_vcenter_sso.providers_delete(provider_id, profile=None)

Delete an identity provider.

CLI Example:

salt '*' vcf_vcenter_sso.providers_delete <provider_id>

saltext.vcf.modules.vcf_vcenter_sso.groups_list(domain=None, profile=None)

List groups, optionally filtered by domain.

CLI Example:

salt '*' vcf_vcenter_sso.groups_list domain=vsphere.local

saltext.vcf.modules.vcf_vcenter_sso.groups_get(group, profile=None)

Return a group by id.

CLI Example:

salt '*' vcf_vcenter_sso.groups_get <group>

saltext.vcf.modules.vcf_vcenter_sso.groups_get_or_none(group, profile=None)

Return the group or None if missing.

CLI Example:

salt '*' vcf_vcenter_sso.groups_get_or_none <group>

saltext.vcf.modules.vcf_vcenter_sso.groups_create(name, domain, description='', profile=None)

Create a group.

CLI Example:

salt '*' vcf_vcenter_sso.groups_create <name> <domain> <description>

saltext.vcf.modules.vcf_vcenter_sso.groups_update(group, spec, profile=None)

PATCH a group.

CLI Example:

salt '*' vcf_vcenter_sso.groups_update <group> spec='{"description": "new"}'

saltext.vcf.modules.vcf_vcenter_sso.groups_delete(group, profile=None)

Delete a group by id.

CLI Example:

salt '*' vcf_vcenter_sso.groups_delete <group>

saltext.vcf.modules.vcf_vcenter_sso.group_add_member(group, member, profile=None)

Add a member to a group.

CLI Example:

salt '*' vcf_vcenter_sso.group_add_member <group> <member>

saltext.vcf.modules.vcf_vcenter_sso.group_remove_member(group, member, profile=None)

Remove a member from a group.

CLI Example:

salt '*' vcf_vcenter_sso.group_remove_member <group> <member>

saltext.vcf.modules.vcf_vcenter_sso.users_list(domain=None, profile=None)

List users, optionally filtered by domain.

CLI Example:

salt '*' vcf_vcenter_sso.users_list domain=vsphere.local

saltext.vcf.modules.vcf_vcenter_sso.users_get(user, profile=None)

Return a user by id.

CLI Example:

salt '*' vcf_vcenter_sso.users_get <user>

saltext.vcf.modules.vcf_vcenter_sso.users_get_or_none(user, profile=None)

Return the user or None if missing.

CLI Example:

salt '*' vcf_vcenter_sso.users_get_or_none <user>

saltext.vcf.modules.vcf_vcenter_sso.users_create(username, domain, password, description='', email=None, profile=None)

Create a local SSO user.

CLI Example:

salt '*' vcf_vcenter_sso.users_create alice vsphere.local <password>

saltext.vcf.modules.vcf_vcenter_sso.users_update(user, spec, profile=None)

PATCH a user.

CLI Example:

salt '*' vcf_vcenter_sso.users_update <user> spec='{"description": "new"}'

saltext.vcf.modules.vcf_vcenter_sso.users_delete(user, profile=None)

Delete a user by id.

CLI Example:

salt '*' vcf_vcenter_sso.users_delete <user>