Element details field descriptions

Last Updated : Jun 07, 2024 |
Prolog information
Note:
The fields on this page varies with the application that you manage.

General

Name
Description
Type
The application type whose instance you want to create.
The following field is available only for specific applications, such as Session Manager and Presence Services.
Name
Description
Select type of <application name> to add
The application type whose instance you want to create.
For example, for Presence Services, you can select a standalone Presence Services or Presence Services on Avaya Breeze® platform.
Name
Description
Name
The name of the element.
Type
The type of the application to which the element belongs.
Description
A brief description of the element.
Node
The node on which you run the element. The IP address can be in the IPv4 or IPv6 format.
Note:
The system displays the Node field when you select Other from the Node field.
Device Type
The device type of the element.
For example, for IP Office, the device type can be IP Office or B5800.

Access Profile

Name
Description
Name
The name of the access profile.
Access Profile Type
The type of the access profile. The options are:
  • URI: For system web services API.
  • SSH: For application upgrade functions.
  • SNMP: For discovering elements.
Access Profile Sub Type
The sub type of the URI access profile. The options are:
  • EMURL: To create a URL type access profile.
  • WS: To create a web service access profile.
  • GUI: To create a GUI access profile.
  • GRCommunication: To create a GR-aware element.
  • TenantURL: To create the tenant-related access profile.
  • Other
Protocol
The protocol that the element supports to communicate with other communication devices.
Host
The name of the host on which the element is running.
Port
The port on which the element is running.
Order
The order in which you gain access to access profiles.
Button
Description
View
Displays fields in the Access Profile section that you can use to view access profile details.
New
Displays the Application System Supported Protocol and Access Profile Details subsections in the Access Profile section to add access profile details.
Edit
Displays fields in the Access Profile section using which you can modify the access profile details that you select.
Delete
Deletes the selected access profile.

Application System Supported Protocol

The system displays the following fields when you click New or Edit in the Access Profile section:
Name
Description
Protocol
The protocol used to access profiles. The options are:
  • URI: For system web services API.
  • SSH: For application upgrade functions.
  • SNMP: For discovering elements.
Note:
The page displays the button only when you click Add or Edit in the Access Profile section.

Access Profile Details

The page displays the following fields when you click URI in the Protocol field:
Name
Description
Name
The name of the access profile.
Access Profile Type
The type of the access profile. The options are:
  • EMURL: To create a URL type access profile.
  • WS: To create a web service access profile.
  • GUI: To create a GUI access profile.
  • GRCommunication: To create a GR-aware element.
  • TenantURL: To create the tenant-related access profile.
  • Other
Protocol
The protocol for communicating the element.
Host
The name of the host on which the element is running.
Port
The port on which the element is running.
Path
The path to gain access to the access profile.
Order
The order in which you gain access to access profiles.
Description
A brief description of the access profile.
The page displays the following fields when you click SSH in the Protocol field:
Name
Description
Name
The name of the access profile.
Login Name
The login name as configured on the element.
Port
The port on which the element is running.
Password
The password to log in to the element.
Confirm Password
The password that you retype.
The page displays the fields when you click SNMP in the Protocol field and V3 in the Type field:
Name
Description
Profile Name
The name of the profile.
Description
A brief description of the profile.
Type
The SNMP protocol type.
User
The user name as defined in the element.
Authentication Type
The authentication protocol used to authenticate the source of traffic from SNMP V3 users. The possible values are:
  • MD5
    The default is MD5.
  • SHA
  • None
Authorization Type applies only to the SNMP V3 protocol.
Authentication Password
The password to authenticate the user. The password must contain at least eight characters.
Note:
The password is mandatory.
Confirm Authentication Password
The SNMP V3 protocol authentication password that you retype for confirmation.
Privacy Type
The encryption policy for an SNMP V3 user. The possible values are:
  • AES: For SNMP-based communication.
  • AES128: For SNMP-based communication.
  • DES: For SNMP-based communication.
    The default is DES.
  • None: Does not encrypt traffic for this user.
Set Privacy Type only for an SNMP V3 user.
Privacy Password
The password used to enable the DES or AES encryption. DES passwords must contain at least eight characters.
Confirm Privacy Password
The privacy password that you retype for confirmation.
Privileges
The privileges that determine the operations that you can perform on MIBs.
  • None
    The default is None.
  • Read/Write: To perform GET and SET operations.
  • Read: To perform only the GET operation.
Timeout
The time in milliseconds for which the element waits for a response from the device being polled during discovery.
Retries
The number of times that the element polls a device without receiving a response before timing out.
The page displays the fields when you click SNMP in the Protocol field and V1 in the Type field:
Name
Description
Profile Name
The name of the profile.
Description
A brief description of the profile.
Type
The SNMP protocol type.
Note:
To upgrade Communication Manager using SNMP protocol, you must select SNMPV1.
Read Community
The read community of the device.
Read Community applies only to the SNMP V1 protocol.
Write Community
The write community of the device.
Write Community applies only to the SNMP V1 protocol.
Timeout
The time in milliseconds for which the element waits for a response from the device that the element polls.
Retries
The number of times that the element polls a device and fails to receive a response. After the retries, the element times out.
Button
Description
Save
Saves the access profile details.
Note:
This button is available only when you click Add and Edit in the Access Profile section.
Cancel
Cancels the operation of creating or editing an access profile and hides the fields where you enter or modify the access profile information.
Note:
This button is available only when you click Add and Edit in the Access Profile section.

Port

Name
Description
Name
The name of the port.
Port
The port on which the element is running.
Protocol
The protocol for the corresponding port.
Description
A brief description about the port.
Button
Description
New
Displays fields in the Port section that you can use to add a port.
Edit
Displays fields in the Port section with port information. You can change the port details in the port mode.
Delete
Deletes the selected configured port.
Commit
Saves the port details.
Note:
The section displays the Save button only when you click Add or Edit in the Port section.
Cancel
Cancels the current operation of creating or editing an access profile and hides the fields where you add or modify the port information.
Note:
The section displays the Cancel button only when you click Add or Edit in the Port section.

Attributes

Use this section to configure attributes for the selected element.
The following fields display the information about attributes defined for System Manager.
Name
Description
IP
The IP address of System Manager.
FQDN
FQDN of System Manager.
Virtual IP
The virtual IP address of System Manager.
Virtual FQDN
The virtual FQDN of System Manager.
isPrimary
The option to indicate if the element is primary or secondary.

Assign elements

Name
Description
Name
The name of the element.
Type
The type of the application to which the element belongs.
Description
A brief description about the element.
Button
Description
Assign elements
Displays the Assign elements page that you use to assign an element to another element.
Unassign elements
Removes an assigned element.
Button
Description
Commit
Creates or modifies an element by saving the information to the database.
Note:
The system displays the button only when you click Add or Edit on the Manage Elements page.
Cancel
Closes the page without saving the information and navigates back to the Manage Elements page.
For example, the following fields provide information about attributes that you can define for Messaging.
Name
Description
Login
The name in the Trusted Server Name field of the Trusted Servers page on the Messaging server.
Password
The password as given in the Password field of the Trusted Servers page on the Messaging server.
Confirm Password
The password that you retype for confirmation.
Messaging Type
The type of the Messaging server. The following types are supported:
  • MM: Modular Messaging
  • CMM: Communication Manager Messaging
  • AURAMESSAGING: Avaya Aura® Messaging
Version
The version of Messaging. Supported versions are 5.0 and later.
Secured LDAP Connection
An option to use the secure LDAP connection.
To use the nonsecure LDAP connection, you must clear the check box.
Port
The port on which the LDAP or secure LDAP service that the element provides is running. The default port is 389 for LDAP and 636 for secure LDAP.
Location
The location of the element.