backendExecute (Command)
  • 18 Dec 2024
  • 3 Minutes à lire
  • Sombre
    Lumière
  • PDF

backendExecute (Command)

  • Sombre
    Lumière
  • PDF

The content is currently unavailable in French. You are viewing the default English version.
Résumé de l’article

The backendExecute command executes back-end server–related administrative operations.

  Table:  backendExecute commands
CommandDescription
BACKENDCMD_CREATE

Registers a new back-end server (see  BACKENDCMD_CREATE).

BACKENDCMD_DELETE

Deletes the specified back-end server entry (see  BACKENDCMD_DELETE).

BACKENDCMD_UPDATE

Updates the settings for the specified back-end server (see  BACKENDCMD_UDPATE).

BACKENDCMD_VIEW

Displays the settings for the specified back-end server (see  BACKENDCMD_VIEW).

Parameters

  Table:  backendExecute input parameters
Paramter nameData typeDescription
sessionIDString

Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see  logon (Command)).

cmdBackEndCmdIDEnum

The operation to be executed. See Table: backendExecute commands.

attributeSetBackEndAttributeSetA set containing zero or more attribute fields.
  Table:  backendExecute output parameters
Paramter nameData typeDescription
resultsBackEndResultsResult structure containing return and status codes and a list of zero or more result attribute fields.

The following field attributes are available for the operations of this command:

  Table:  backendExecute field attributes
Attribute nameData typeDescription
BACKENDFLD_AUTH_IP_ADDRESSStringValid IPv4 address.
BACKENDFLD_AUTH_PORTIntegerPossible values: 165535
BACKENDFLD_AUTH_PORT_SSLIntegerThe SSL authentication port.
BACKENDFLD_BACKEND_PROTOCOL_IDString

Communication protocol identifier.

Up to 32 characters.

BACKENDFLD_BACKEND_SERVER_IDString

The unique back-end server identifier.

Up to 80 characters.

BACKENDFLD_CHARACTER_ENCODINGString 
BACKENDFLD_CREATE_TIMEDateTime

The date and time the data record was created.

BACKENDFLD_CUSTOM_REALMString

Specifies an optional custom realm to be appended to the user name in RADIUS Access-Request packets if BACKENDFLD_INCLUDE_REALM is set.

This attribute applies to RADIUS back-end servers only.

Up to 255 characters.

BACKENDFLD_DIRECTORY_AUTHStringReserved for future use.
BACKENDFLD_DIRECTORY_BASE_DNStringThe base distinguished name (DN) used by the LDAP server when initiating searches.
BACKENDFLD_DOMAINStringUp to 255 characters.
BACKENDFLD_EMAIL_ATTRIBUTEString

The LDAP attribute name that serves as the user's email address for DUR user information synchronization.

Up to 64 characters.

BACKENDFLD_INCLUDE_REALMString

Determines whether a user realm should be appended to the user name in RADIUS Access-Request packets. The realm is either set to BACKENDFLD_CUSTOM_REALM (if specified) or to the resolved domain name of the respective user.

This attribute also specifies the notation to use when appending the realm, i.e. either prefix (REALM\USER) or postfix notation (USER@REALM).

This attribute applies to RADIUS back-end servers only.

Possible values:

  • No
  • Yes - Prefix
  • Yes - Postfix
BACKENDFLD_MOBILE_ATTRIBUTEString

The LDAP attribute name that serves as the user's mobile phone number for DUR user information synchronization.

Up to 64 characters.

BACKENDFLD_MODIFY_TIMEDateTime

The date and time the data record was last modified.

BACKENDFLD_PHONE_ATTRIBUTEString

The LDAP attribute name that serves as the user's landline phone number for DUR user information synchronization.

Up to 64 characters.

BACKENDFLD_PRIORITYIntegerUsed if there is more than one back-end server. A higher number will denote a higher priority. The server with the highest priority is tried first, then the next highest, etc.
BACKENDFLD_RADIUS_ACCT_IP_ADDRESSStringValid IPv4 address.
BACKENDFLD_RADIUS_ACCT_PORTIntegerPossible values: 165535
BACKENDFLD_RADIUS_AUTH_IP_ADDRESSStringValid IPv4 address.
BACKENDFLD_RADIUS_AUTH_PORTIntegerPossible values: 165535
BACKENDFLD_RADIUS_SHARED_SECRETStringUp to 255 characters.
BACKENDFLD_RETRIESInteger

Possible values: 165535

BACKENDFLD_SECURITY_PRINCIPAL_DNStringDN of an administrator account to use when sending a query to an LDAP back-end authenticator.
BACKENDFLD_SECURITY_PRINCIPAL_PASSWORDStringPassword for the Security_Principle account.
BACKENDFLD_TIMEOUTIntegerPossible values: 1999
BACKENDFLD_USER_ID_ATTRIBUTEString

The common name used for searching.

Default value: cn

BACKENDFLD_USER_OBJECT_CLASSString

The object class used by the LDAP server to hold attributes about people.

Default value: inetOrgPerson

BACKENDFLD_USERNAME_ATTRIBUTEString

The LDAP attribute name that serves as the user's display name for DUR user information synchronization.

Up to 64 characters.

BACKENDCMD_CREATE

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: BACKENDCMD_CREATE (Supported input attributes)
Attribute nameOptional?
BACKENDFLD_AUTH_IP_ADDRESSOptional
BACKENDFLD_AUTH_PORTOptional
BACKENDFLD_AUTH_PORT_SSLOptional
BACKENDFLD_BACKEND_PROTOCOL_IDMandatory
BACKENDFLD_BACKEND_SERVER_IDMandatory
BACKENDFLD_CHARACTER_ENCODINGOptional
BACKENDFLD_CUSTOM_REALMOptional
BACKENDFLD_DIRECTORY_AUTHOptional
BACKENDFLD_DIRECTORY_BASE_DNOptional
BACKENDFLD_DOMAINOptional
BACKENDFLD_EMAIL_ATTRIBUTEOptional
BACKENDFLD_INCLUDE_REALMOptional
BACKENDFLD_MOBILE_ATTRIBUTEOptional
BACKENDFLD_PHONE_ATTRIBUTEOptional
BACKENDFLD_PRIORITY

Optional

BACKENDFLD_RADIUS_ACCT_IP_ADDRESSOptional
BACKENDFLD_RADIUS_ACCT_PORTOptional
BACKENDFLD_RADIUS_SHARED_SECRETOptional
BACKENDFLD_RETRIESOptional
BACKENDFLD_SECURITY_PRINCIPAL_DNOptional
BACKENDFLD_SECURITY_PRINCIPAL_PASSWORDOptional
BACKENDFLD_TIMEOUTOptional
BACKENDFLD_USERNAME_ATTRIBUTEOptional

The following attributes will be specified in the results output parameter of this command:

  Table: BACKENDCMD_CREATE (Suppored output attributes)
Attribute nameReturned?
BACKENDFLD_BACKEND_PROTOCOL_IDAlways
BACKENDFLD_BACKEND_SERVER_IDAlways
BACKENDFLD_CHARACTER_ENCODINGIf defined
BACKENDFLD_CUSTOM_REALMIf defined
BACKENDFLD_DOMAINIf defined
BACKENDFLD_EMAIL_ATTRIBUTEIf defined
BACKENDFLD_INCLUDE_REALMIf defined
BACKENDFLD_MOBILE_ATTRIBUTEIf defined
BACKENDFLD_MODIFY_TIMEAlways
BACKENDFLD_MODIFY_TIMEAlways
BACKENDFLD_PHONE_ATTRIBUTEIf defined
BACKENDFLD_PRIORITYIf defined
BACKENDFLD_RADIUS_ACCT_IP_ADDRESSIf defined
BACKENDFLD_RADIUS_ACCT_PORTIf defined
BACKENDFLD_RADIUS_AUTH_IP_ADDRESSIf defined
BACKENDFLD_RADIUS_AUTH_PORTIf defined
BACKENDFLD_RADIUS_RETRIESIf defined
BACKENDFLD_RADIUS_SHARED_SECRETIf defined
BACKENDFLD_RADIUS_TIMEOUTIf defined
BACKENDFLD_USERNAME_ATTRIBUTEIf defined

BACKENDCMD_VIEW

Only the BACKENDFLD_BACKEND_SERVER_ID attribute can be specified in the back-end attribute set input parameter of this command. This attribute is mandatory.

The following attributes will be specified in the results output parameter of this command:

  Table: BACKENDCMD_VIEW (Supported output attributes)
Attribute nameReturned?
BACKENDFLD_AUTH_IP_ADDRESSIf defined
BACKENDFLD_AUTH_PORTIf defined
BACKENDFLD_BACKEND_PROTOCOL_IDIf defined
BACKENDFLD_BACKEND_SERVER_IDAlways
BACKENDFLD_CHARACTER_ENCODINGIf defined
BACKENDFLD_CUSTOM_REALMIf defined
BACKENDFLD_DOMAINIf defined
BACKENDFLD_EMAIL_ATTRIBUTEIf defined
BACKENDFLD_INCLUDE_REALMIf defined
BACKENDFLD_MOBILE_ATTRIBUTEIf defined
BACKENDFLD_MODIFY_TIMEAlways
BACKENDFLD_MODIFY_TIMEAlways
BACKENDFLD_PHONE_ATTRIBUTEIf defined
BACKENDFLD_PRIORITYIf defined
BACKENDFLD_RADIUS_ACCT_IP_ADDRESSIf defined
BACKENDFLD_RADIUS_ACCT_PORTIf defined
BACKENDFLD_RADIUS_SHARED_SECRETIf defined
BACKENDFLD_RETRIESIf defined
BACKENDFLD_TIMEOUTIf defined
BACKENDFLD_USERNAME_ATTRIBUTEIf defined

BACKENDCMD_UDPATE

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: BACKENDCMD_UDPATE (Supported input attributes)
Attribute nameOptionality
BACKENDFLD_AUTH_IP_ADDRESSOptional
BACKENDFLD_AUTH_PORTOptional
BACKENDFLD_BACKEND_PROTOCOL_IDMandatory
BACKENDFLD_BACKEND_SERVER_IDMandatory
BACKENDFLD_CHARACTER_ENCODINGOptional
BACKENDFLD_CUSTOM_REALMOptional
BACKENDFLD_DOMAINOptional
BACKENDFLD_EMAIL_ATTRIBUTEOptional
BACKENDFLD_INCLUDE_REALMOptional
BACKENDFLD_MOBILE_ATTRIBUTEOptional
BACKENDFLD_PHONE_ATTRIBUTEOptional
BACKENDFLD_PRIORITYOptional
BACKENDFLD_RADIUS_ACCT_IP_ADDRESSOptional
BACKENDFLD_RADIUS_ACCT_PORTOptional
BACKENDFLD_RADIUS_SHARED_SECRETOptional
BACKENDFLD_RETRIESOptional
BACKENDFLD_TIMEOUTOptional
BACKENDFLD_USERNAME_ATTRIBUTEOptional

The following attributes will be specified in the results output parameter of this command:

  Table: BACKENDCMD_UDPATE (Supported output attributes)
Attribute nameReturned?
BACKENDFLD_AUTH_IP_ADDRESSIf defined
BACKENDFLD_AUTH_PORTIf defined
BACKENDFLD_BACKEND_PROTOCOL_IDIf defined
BACKENDFLD_BACKEND_SERVER_IDAlways
BACKENDFLD_CHARACTER_ENCODINGIf defined
BACKENDFLD_CUSTOM_REALMIf defined
BACKENDFLD_DOMAIN_NAMEIf defined
BACKENDFLD_EMAIL_ATTRIBUTEIf defined
BACKENDFLD_INCLUDE_REALMIf defined
BACKENDFLD_MOBILE_ATTRIBUTEIf defined
BACKENDFLD_MODIFY_TIMEAlways
BACKENDFLD_PHONE_ATTRIBUTEIf defined
BACKENDFLD_PRIORITYIf defined
BACKENDFLD_RADIUS_ACCT_IP_ADDRESSIf defined
BACKENDFLD_RADIUS_ACCT_PORTIf defined
BACKENDFLD_RADIUS_SHARED_SECRETIf defined
BACKENDFLD_RETRIESIf defined
BACKENDFLD_TIMEOUTIf defined
BACKENDFLD_USERNAME_ATTRIBUTEIf defined

BACKENDCMD_DELETE

Only the BACKENDFLD_BACKEND_SERVER_ID attribute can be specified in the back-end attribute set input parameter of this command. This attribute is mandatory and serves as a unique back-end server identifier.

This command returns no result attributes.


Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle