Yealink Federation Management v2 Platform Guide
en
Yealink Federation Management Platform Guide V24.0.2.20
Contents
About This Guide..................................................................................................... 3 Introduction of Yealink Federation Management Platform................................................................................. 3 In This Guide........................................................................................................................................................4
Deploying Yealink Federation Management Platform..........................................4 Overview of Deployment..................................................................................................................................... 4 Installing the Stand-Alone Version...................................................................................................................... 5 Installing the Cluster Version............................................................................................................................... 6 Logging into Yealink Federation Management Platform.....................................................................................8 Setting the Node................................................................................................................................................... 8 Setting the Redirect Service................................................................................................................................. 9 Adding Federation Members.............................................................................................................................. 10 Linking YMS to Yealink Federation Management Platform............................................................................. 12 Uninstalling Yealink Federation Management Platform.................................................................................... 12
System Settings........................................................................................................12 Setting the Central Access Address................................................................................................................... 12 Setting the Disk Space....................................................................................................................................... 12 Setting the SMTP Mailbox.................................................................................................................................13 Importing HTTPS Certificate............................................................................................................................. 14
System Maintenance............................................................................................... 14 Viewing the System Version.............................................................................................................................. 14 Upgrading the System........................................................................................................................................ 14 Setting the Auto Backup.................................................................................................................................... 15 Creating a Backup Manually..............................................................................................................................15 Downloading a Backup...................................................................................................................................... 15 Rebooting the System.........................................................................................................................................15 Viewing the Operation Log................................................................................................................................15 Viewing the System Log.................................................................................................................................... 16
Using YMS...............................................................................................................16 Synchronizing the Information of the Account and the Meeting Room............................................................16 Synchronizing the Call Routing Information.....................................................................................................16 Synchronizing the Federation List..................................................................................................................... 16 Synchronizing the Information of the Master Domain......................................................................................17 Managing the Subordinate YMS........................................................................................................................17 Synchronizing the Number Resource.................................................................................................................17 Managing the Federation Data........................................................................................................................... 17 Managing the Data of the Subordinate Federation............................................................................................ 17 Federation Conferences...................................................................................................................................... 18
Creating Federation Conferences........................................................................................................... 18 Placing a Fast Call..................................................................................................................................19 Controlling the Federation Conferences.................................................................................................20
| About This Guide | 3
About This Guide
This guide mainly introduces how to install and use Yealink Federation Management Platform.
The installation of Yealink Federation Management Platform can be divided into stand-alone and cluster.
The differences between them are as below:
Type Description
Installing Stand-Alone YMS Install one node.
Installing Cluster YMS To make the management has a higher availability, you can install multiple nodes, which includes the following types:
Master node: only one node. Sub-master node: multiple (the quantity should
be an even number)
Total nodes: one master node +all sub-master nodes (the quantity should be an odd number).
Introduction of Yealink Federation Management Platform In This Guide
Introduction of Yealink Federation Management Platform Yealink Federation Management Platform mainly applies to the government of the province, the city, the town, and the county. Different administrative-level governments can deploy YMS independently, and the provincial government can build a unified Federation Management Platform based on the unified account number in the province, and allocate the number field to the city, the town or the county. Under this circumstance, account number conflict among different administrative divisions can be avoided, and the management of the account information under different administrative divisions can be realized.
| Deploying Yealink Federation Management Platform | 4
In This Guide This guide contains those chapters.
Chapter 1Deploying Yealink Federation Management Platform Chapter 2System Settings Chapter 3System Maintenance Chapter 4Using YMS
Deploying Yealink Federation Management Platform
Overview of Deployment Installing the Stand-Alone Version Installing the Cluster Version Logging into Yealink Federation Management Platform Setting the Node Setting the Redirect Service Adding Federation Members Linking YMS to Yealink Federation Management Platform Uninstalling Yealink Federation Management Platform
Overview of Deployment You can follow the steps below to deploy Yealink Federation Management Platform.
Table 1: Overview of Deployment
Step Task Target
1 Installing the Stand-Alone Version /Installing the Cluster Version
Install Yealink Federation Management Platform.
2 Setting the Node Set the basic network information for the server node to ensure that the network works smoothly.
3 Setting the Redirect Service For the federation members to register YMS accounts. If the following two situations occur, users should enter the proxy server address when registering YMS accounts. One, the server domain name you entered cannot be resolved; two, it can be resolved but cannot be resolved to the specific address used by the registration service. The proxy server refers to the node used by the redirect service, and the federation members can enter the same proxy server address.
| Deploying Yealink Federation Management Platform | 5
Step Task Target
4 Adding Federation Members Add the federation members of the province, the city, the town and the county.
5 Linking YMS to Yealink Federation Management Platform
Link YMS to the corresponding federation member.
Installing the Stand-Alone Version
Before you begin
For the installation environment, we recommend CentOS 7.5 or later.
Procedure
1. Put the installation package to the usr/local path. For example, when uploading the file to CentOS via lrzsz, you can do the following:
Use SecureCRT to go to CentOS via SSH and run the following:
yum -y install lrzsz
cd /usr/local
rz
Select the installation package that you want to upload. 2. Use SecureCRT to go to CentOS via SSH and run the following:
cd /usr/local
tar -xzvf FMC_10.0.0.5.tar.gz
cd apollo_install
tar xvzf install.tar.gz
./install.sh 3. Enter A to select the stand-alone installation.
If you do not select within 30 seconds, the system will select the stand-alone installation automatically. The installation will be finished in about 10 minutes. Please wait.
| Deploying Yealink Federation Management Platform | 6
Results The installation succeeds if the page displays the following part:
Installing the Cluster Version
Before you begin
For the installation environment, we recommend CentOS 7.5 or later. The network among all the nodes can be accessed. We recommend that all the nodes can access the external
network. YMS is not installed in all the nodes.
Procedure
1. Put the installation package to the usr/local path. For example, when uploading the file to CentOS via lrzsz, you can do the following:
Use SecureCRT to go to CentOS via SSH and run the following:
yum -y install lrzsz
cd /usr/local
rz
Select the installation package that you want to upload. 2. Use SecureCRT to go to CentOS via SSH and run the following:
cd /usr/local
tar -xzvf FMC_10.0.0.5.tar.gz
cd apollo_install
| Deploying Yealink Federation Management Platform | 7
tar xvzf install.tar.gz
./install.sh 3. Enter B to select the cluster installation.
4. Run the command: vi /usr/local/apollo/data/install.conf 5. Enter A to edit the configuration file.
For example, in the current environment, set 10.200.112.179 as the master node, set 10.200.112.89 and 10.200.112.22 as the sub-master nodes.
6. Press Esc to exit, and run the following command: :wq
./install.sh
Results The installation succeeds if the page displays the following part:
| Deploying Yealink Federation Management Platform | 8
Logging into Yealink Federation Management Platform
Procedure
1. Open a web browser. 2. Enter the IP address or domain name of Yealink Federation Management Platform in the address bar, and then
press the Enter key to go to the Login page. 3. Enter the username and the password.
Note: By default, the username is admin and the password is 123456.
4. In the top-right corner, select the desired display language from the drop-down menu. 5. Click Login.
If you forget the password, you can click Forgot Password, and reset the password according to the prompts.
Setting the Node You can configure the basic network information of the server node to get a smooth network.
Procedure
1. Click System Setting > Node Management. 2.
Click on the right side of desired node, and edit the parameters.
Note:
Make sure that the DNS server is available. Otherwise, the service will be abnormal. You can configure only one default routing; when the adapter has multiple IP addresses, the routing
of all the IP addresses should be specified, the default one cannot be used; the smaller the number is, the higher the priority is; the routing rule came with the system cannot be deleted. If it is deleted, other added routing rules will be abnormal.
For a single network adapter deployment in the external network, you must configure two intranet IP addresses, one mapped to the public network with the public button on and the other mapped to the intranet (only mapping one IP address is not allowed). Only mapping one intranet IP address to the public network will make the service abnormal. For more information, refer to Yealink Meeting Server Network Deployment Guide.
| Deploying Yealink Federation Management Platform | 9
If your YMS is the cluster version, you cannot edit the IP address of the master node on the management platform. You can edit it in the installation file and re-install it. For more information, refer to Installing the Cluster Version .
Setting the Redirect Service The federation members can register YMS accounts via redirect service. If the following two situations occur, users should enter the proxy server address when registering YMS accounts. One, the server domain name you entered cannot be resolved; two, it can be resolved but cannot be resolved to the specific address used by the registration service. The proxy server refers to the node used by the redirect service, and the federation members can enter the same proxy server address.
Procedure
1. Click Service > SIP Service > Redirect Service > Add. 2. Configure the corresponding parameters.
Table 2: Basic Parameters
Parameter Description
Enabled Enable or disable this service.
Default: enabled.
Name The service name.
Node The node used by this service.
3. Configure the parameters of the service address.
| Deploying Yealink Federation Management Platform | 10
Table 3: Service address
Parameter Description
Network The IP address of this node.
TLS port The TLS port used by this node.
Note: only TLS registration is available.
4. Click Save. 5. Operate according to the prompts, and click OK.
Adding Federation Members You need add members of the province, the city, the town and the county, so that you can configure the area code and the domain name for every administrative division.
About this task After you add the federation members, the system will automatically synchronize the federation information to the corresponding YMS one hour later, if the synchronization failed, you can manually synchronize the federation information. For more information, refer to Using YMS .
Procedure
1. Click Federation Management > Add Federation Member. 2. Configure the corresponding parameters.
Table 4:
Parameter Description
Primary Domain Specify the domain name for authentication. When the device is registering, the server address will be directed to this domain name.
Username The user name.
Password The password of the user.
| Deploying Yealink Federation Management Platform | 11
3. Click Add to allocate the number resource.
Table 5: Parameters of the number
Parameter Description
Number type The type of the number.
The supported types are as follows:
System account: it contains the user accounts and the room system accounts.
All conference: it contains the number of scheduled conferences, Meet Now conferences and VMRs.
Meet Now Scheduled conference VMR
Note: if you set All conference and Meet Now, the system will use the Meet Now with priority. This can also be applied to Scheduled conference and VMR.
Origin section The origin section.
Rear section The rear section.
Description The additional notes.
| System Settings | 12
Linking YMS to Yealink Federation Management Platform Contact Yealink technical support to link YMS to Yealink Federation Management Platform.
About this task Note that if you link YMS to Yealink Federation Management Platform, all data on YMS will be cleaned up.
Uninstalling Yealink Federation Management Platform
Procedure
1. Log into CentOS as the root. 2. Go to the terminal. 3. Run the command: apollo-uninstall
For the cluster installation, you need run this command on each node. 4. Enter the password which can be obtained from Yealink.
System Settings
Setting the Central Access Address Setting the Disk Space Setting the SMTP Mailbox Importing HTTPS Certificate
Setting the Central Access Address You can set the server URL for the internal and network separately, and the server will send the corresponding address to the device according to the network where the device locates in. When you reset the password, you will receive the email sent by the system. The link in the email may contains the central access address.
Procedure
1. Click System Settings > Common Settings > Central access addressAdd. 2. In the Service network field, select Internal network/External network. 3. Enter the URL in the Service URL field. 4. Click OK.
Setting the Disk Space You can allocate the space quota for the Syslog and the Backup space manually.
Before you begin The space quota should be an integer value, and the space quota of each part should not be less than its default space quota.
| System Settings | 13
Procedure
1. Click System Setting > Common Setting > Data Space. 2. Enter the desired quota in the corresponding field. 3. Click Save.
Setting the SMTP Mailbox You can use the SMTP mailbox to send emails to users. For example, the email of resetting the password.
Procedure
1. Click System Setting > Common Setting > SMTP Mailbox. 2. Configure the parameters.
3. Click Test Mailbox Setting. 4. Enter the test address in the Test Mailbox field. 5. Click OK.
If the mailbox connection succeeds, the prompt Operation success is popped up.
Note: If the mailbox connection fails, make sure the connection between YMS and SMTP server can work and the account information is correct.
6. Click Save.
| System Maintenance | 14
Importing HTTPS Certificate When you access Yealink Federation Management Platform by HTTPS protocol, the browser will prompt that it is insecure. To solve this problem, you can import the certificate trusted by the browser.
Before you begin You have obtained the device certificate issued by CA.
Procedure
1. Click System Setting > Certificate > HTTPS Certificate > Import. 2. Click Upload, select the desired certificate. 3. Click OK.
System Maintenance
Viewing the System Version Upgrading the System Setting the Auto Backup Creating a Backup Manually Downloading a Backup Rebooting the System Viewing the Operation Log Viewing the System Log
Viewing the System Version You can view the current system version to update the system in time.
Procedure
Click Maintenance > Upgrade > System Upgrade.
Upgrading the System When a new version is available, you can upgrade Yealink Federation Management Platform. The latest version can be obtained from Yealink.
Procedure
1. Click Maintenance > Upgrade > System Upgrade. 2. Click Update, select the software to upgrade the system.
| System Maintenance | 15
Setting the Auto Backup You can enable the Auto backup, so that the server can create a backup for the important information automatically.
Procedure
1. Click Maintenance > Backup > Setting. 2. Configure the parameter of the auto backup. 3. Click OK.
Creating a Backup Manually You can create a backup for Yealink Federation Management Platform manually.
Procedure
1. Click Maintenance > Backup > Add. 2. Enter the file name. 3. Click OK.
Downloading a Backup You can download the desired backup of YMS.
Procedure
1. Click Maintenance > Backup. 2.
Click on the right side of the desired file.
Rebooting the System When you fail to upgrade the system, for example it remains on a certain page, you can reboot the system.
Procedure
1. Click Maintenance > System Restart. 2. Select the desired node, and click Restart. 3. Click OK.
Viewing the Operation Log The operation log keeps a record of the change history, including the access record and the configuration record of Yealink Federation Management Platform.
Procedure
Click Maintenance > Support Log > Operation Log.
Tip: You can also click Export Log in the top right corner to view the log.
| Using YMS | 16
Viewing the System Log You can view the system log to find out the reason when a problem occurs to the server.
Procedure
1. Click Maintenance > Support Log > System log. 2. Select the time, the module, and the node to export the log. 3. Click Export Syslog.
Using YMS
This chapter introduces how to synchronize the data and manage YMS after YMS is linked to Yealink Federation Management Platform.
Synchronizing the Information of the Account and the Meeting Room Synchronizing the Call Routing Information Synchronizing the Federation List Synchronizing the Information of the Master Domain Managing the Subordinate YMS Synchronizing the Number Resource Managing the Federation Data Managing the Data of the Subordinate Federation Federation Conferences
Synchronizing the Information of the Account and the Meeting Room You can synchronize the information of the user account, the room system account, other account, the entity meeting room, and the VMR on Yealink Federation Management Platform.
Procedure
Click Account > User Account/Room System Account/Other Account/Entity Meeting Room/Virtual Meeting Room > Synchronize.
Synchronizing the Call Routing Information
Procedure
Click Call Configuration > Call Routing Rule > Synchronize.
Synchronizing the Federation List
Procedure
Click Service > SIP Service > Redirect Service > Synchronize.
| Using YMS | 17
Synchronizing the Information of the Master Domain
Procedure
Click System Settings > Common Settings > Network Association > Synchronize.
Managing the Subordinate YMS You can log into the subordinate YMS as the system administrator, to manage the accounts, the meeting room and so on. For more information, refer to Yealink Meeting Server Administrator Guide.
Procedure
1. Click System Settings > Common Settings > Federation Management 2.
Click on the right side of the desired subordinate YMS.
Synchronizing the Number Resource
Procedure
Click System Settings > Common Settings > Number Resource AllocationSynchronize.
Managing the Federation Data You can add, edit and delete the accounts, the meeting room information and the number resource.
Procedure
1. Do one of the following:
Click Account > User Account/Room System Account/Other Account/Entity Meeting Room/Virtual Meeting Room > Federation Data Management.
Click System Settings > Common Settings > Number Resource AllocationFederation Data Management. 2. Refer to the corresponding chapters in Yealink Meeting Server Administrator Guide.
Managing the Data of the Subordinate Federation You can add, edit and delete the information of the account and the meeting room.
About this task If there is subordinate organization under your organization, Subordinate management will be displayed on the page.
Procedure
1. Click Subordinate management > Subordinate user account/Subordinate room system account/Subordinate other account/Subordinate meeting room/Subordinate VMR.
| Using YMS | 18
2. Refer to the corresponding chapters in Yealink Meeting Server Administrator Guide.
Federation Conferences When you build a multi-level federation, every level can control the federation conference of its sub levels, for example, change the video layout. You can build a federation, including five different levels at most.
Creating Federation Conferences Placing a Fast Call Controlling the Federation Conferences
Creating Federation Conferences
Do one of the following:
In a province-level YMS, the province-level federation conference can invite all its sub-level federation conferences, and in sub-level YMSs, federation conferences at every level can invite the contacts at the same level.
Inviting via a VMR conference
Inviting via a scheduled conference
In every level YMS, federation conferences at every level can invite its sub-level federation conferences and the contacts at the same level.
Inviting via a VMR conference
| Using YMS | 19
Inviting via a scheduled conference. The sub-level federation conference can only be VMR.
Placing a Fast Call In a province-level YMS, you can place a Fast call on the Conference Control page to invite all the federation conferences and contacts.
Before you begin
Creating Federation Conferences In every level YMS, set the feature of Auto dialing (go to Call Configuration > Call Control Policy).
Procedure
1. On the Conference Control page of the province-level YMS, click Fast Call. 2. Select the desired participants and click Call.
| Using YMS | 20
Controlling the Federation Conferences
Before you begin After the invited federation conference joins the conference (refer to Placing a Fast Call ), there will be data in the list of Federation Control.
Procedure
1. On the Conference Control page, click Federation Control.
2. Do one of the following:
| Using YMS | 21
View the details of all sub-level participants, including the name, the federation they belong to, the conference status, the participant status, and the operation.
Note:
In broadcasting interactive conferences, you cannot see the broadcasting parties in the list of Federation Control.
If you do not find the newly added participants, you need to check whether the federation data is synchronized.
Click Federation and select the desired federation. Click Status and select the desired status.
Conference status: including the attendance ( ) and the absence ( ). Participant status: it displays the status of every venue (for example, the participant is muted or unmuted) and
the call statistics.
Click to go to the Conference Cont