Native
Synchronous
No Custom Parameters
WriteAttribute will add, delete, or replace an attribute on an entry in an LDAP server.
WriteAttribute allows you to add a value, replace a value or values to an attribute on an entry in an LDAP server, or delete an attribute.
The branch condition returned provides useful information in determining the cause of failure:
ConnectionFailure indicates that it was not possible to connect to the LDAP server.
AuthenticationFailure indicates that the Username and Password do not have the necessary permissions to bind to the LDAP server.
WriteFailure indicates that the WriteAttribute action was unable to alter the specified attribute for the specified Dn.
Failure indicates that the action failed unexpectedly for a non-LDAP protocol related reason.
None.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| LdapServerHost * | System.String | The IP address or host name of the LDAP server. | |
| LdapServerPort | System.UInt32 | 0 | The port of the LDAP server. |
| Username | System.String | A user with the appropriate privileges to update the value of an attribute on the specified Dn. | |
| Password | System.String | The password of the user specified in the Username action parameter. | |
| Dn * | System.String | The LDAP entry to write the attribute on. | |
| Type * | Metreos.Native.Ldap.WriteAttribute+WriteType | Specifies which type of operation to perform on the attribute. The list of possible operations are listed:
| |
| AttributeName * | System.String | The name of the attribute to modify. | |
| Value | System.String | Use this parameter instead of Values if specifying a single value for the attribute. | |
| Values | System.Collections.Specialized.StringCollection | Use this parameter instead of Value if specifying an array of values for the attribute. | |
| Version | System.Int32 | 3 | The version of the LDAP server being connected to. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ErrorCode | System.Int32 | An LDAP protocol-specific error code if the action fails due to WriteFailure, AuthenticationFailure, or ConnectionFailure. Note that in any of these three cases, it is not guaranteed that the error code will be populated. The error code will be 0 in the case that no LDAP-specific error code could be found. |
| ErrorMessage | System.String | An LDAP protocol-specific error message if the action fails due to WriteFailure, AuthenticationFailure, or ConnectionFailure. Note that in any of these three cases, it is not guaranteed that the error message will be populated. The error code will be null in the case that no LDAP-specific error message could be found. |
Branch Conditions
No description.
No description.
No description.
No description.
No description.