Scripting Object - VcHostLocalAccountManager

Scripting-object corresponding to
HostLocalAccountManager
Attribute of
VcHostConfigManager, VcSdkConnection, VcServiceContent

Scripting Object Description

This managed object type provides an interface through which local accounts on a host are managed. Note that this managed object applies only to applications that use a local account database on the host to provide authentication (ESX Server, for example). POSIX and win32 hosts may impose different restrictions on the password, ID, and description formats. POSIX host implementation may restrict the user or group name to be lower case letters and less than 16 characters in total. It may also disallow characters such as ";", "\n", and so on. In short, all the platform dependent rules and restrictions regarding naming of users/groups and password apply here. An InvalidArgument fault is thrown if any of these rules are not obeyed.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, assignUserToGroup, createGroup, createTrigger, createUser, removeGroup, removeUser, unassignUserFromGroup, updateUser

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

createUser

Creates a local user account using the parameters defined in the {@link vim.host.LocalAccountManager.AccountSpecification HostLocalAccountManagerAccountSpecification} data object type. For POSIX hosts, passing {@link vim.host.LocalAccountManager.PosixAccountSpecification HostLocalAccountManagerPosixAccountSpecification} data object type allows you to control the format of the user ID of the user account being created. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostAccountSpec


Return Value

Type Description
None

createGroup

Creates a local group account using the parameters defined in the {@link vim.host.LocalAccountManager.AccountSpecification HostLocalAccountManagerAccountSpecification} data object type. For POSIX hosts, passing the {@link vim.host.LocalAccountManager.PosixAccountSpecification HostLocalAccountManagerPosixAccountSpecification} data object type allows you to control the group ID format of the group account being created.

@since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostAccountSpec


Return Value

Type Description
None

removeUser

Removes a local user account.

As of vSphere API 5.1, this operation will first try to remove all permissions associated with the specifed account. The permissions of the user are removed one by one, not atomically, and the operation is not rolled back, if the removal of some permission fails. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

unassignUserFromGroup

Unassigns a user from a group.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

removeGroup

Removes a local group account.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

updateUser

Updates a local user account using the parameters defined in the {@link vim.host.LocalAccountManager.AccountSpecification HostLocalAccountManagerAccountSpecification} data object type. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostAccountSpec


Return Value

Type Description
None

assignUserToGroup

Assigns a user to a group.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None