The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This section describes how to manage system settings, and includes the following sections:
■Configuring Provisioning Settings
Note: To manage system settings, you must be logged in either as root or as a user with Administrative Operations permissions.
System settings are managed from the ADMIN > System Management menu (Admin Menu)
IoT FND tracks active user sessions and lets you log out users.
■Filtering the Active Sessions List
To view active user sessions, choose ADMIN > System Management > Active Sessions. IoT FND displays the Active Sessions page (Active Sessions Page).
Active Session Fields describes the Active Session fields.
|
|
---|---|
The user name in the session record. To view user settings, click the user name. |
|
The IP address of the system the user employs to access IoT FND. |
|
1. Choose ADMIN > System Management > Active Sessions.
2. Select the check boxes for those users you want to log out.
To filter the Active Sessions list using column filtering:
1. Choose ADMIN > System Management > Active Sessions.
2. From the User Name drop-down menu, choose Filters and enter the user name or the first characters in the user name to filter the list.
For example, to list the active sessions for the root user, enter root.
Tip: To remove the filter, from the User Name drop-down menu, clear the Filters check box or click Clear Filter.
Use the audit trail to track IoT Field Network Director user activity.
To display the Audit Trail, choose ADMIN > System Management > Audit Trail
Audit Trail Fields describes the Audit Trail fields.
|
|
---|---|
The user who performed the operation. To view user settings, click the user name. |
|
IP address of the system that the user employs to access IoT FND. |
|
Tip: Click the Refresh icon (far right) to update the list.
To filter the Audit Trail list using column filtering:
1. Choose ADMIN > System Management > Audit Trail.
2. From the User Name drop-down menu, pass over Filters option and in the field that appears enter the user name or the first characters of the user name to filter the list.
For example, to list the Audit Trail entries for the user jane, enter jane.
Tip: To remove the filter, from the User Name drop-down menu, uncheck the Filters check box or click Clear Filter (left of the screen).
The Certificates page displays the certificates for CSMP (CoAP Simple Management Protocol), IoT-DM (IoT Device Manager), and Web used by IoT FND and lets you download these certificates.
To display the CSMP, IoT-DM and Web certificates:
1. Choose ADMIN > System Management > Certificates.
2. To view a certificate, click its corresponding heading (such as Certificate for Routers).
3. To download a certificate, select encoding type (Binary or Base64) radio button, and then click Download.
For more information about certificates, see “Generating and Installing Certificates” in the Cisco IoT Field Network Director Installation Guide.
The Data Retention page lets you determine the number of days to keep event, issue, and metric data in the IoT FND database.
Note: Data retention prunes events even if they have associated open issues.
To set IoT FND data retention:
1. Choose ADMIN > System Management > Data Retention.
2. For each of the retention categories, specify the number of days to retain data.
Data Retention Fields Allowable Maximum Values lists the allowable maximum values for each field.
|
|
||
---|---|---|---|
|
|
|
|
The License Center page, ADMIN > System Management > License Center, lets you view and manage license files.
Note: IoT FND performs license enforcement when importing devices. If you add licenses, IoT FND only allows the permitted number of devices to be imported, as defined in the licenses.
Without licenses, IoT FND allows only 3 routers and 100 mesh endpoints.
To view IoT FND license summary:
1. Choose ADMIN > System Management > License Center.
For every license, IoT FND displays the information described in Device License Summary Information.
Note: IR500s use mesh endpoint licenses, and require no special license.
To view IoT FND license files:
1. Choose ADMIN > System Management > License Center.
2. Click License Files to display details on all active licenses.
For every file, IoT FND displays the fields described in License File Fields.
|
|
---|---|
1. Choose ADMIN > System Management > License Center.
3. Click Add to open a search window.
4. Click Browse to locate the desired license file and then click Open.
5. Click Upload. To cancel the upload, click Reset.
6. Click Reset to cancel the selected file and search for another file.
Note: Ensure that you have access to license files before deleting existing license files. Without licenses, IoT FND allows registration of only 3 routers and 100 mesh endpoints.
To delete a single license or multiple license files:
1. Choose ADMIN > System Management > License Center.
3. Select the box next to each license file that you want to delete.
4. Click Delete. To confirm deletion, click Yes. To cancel the action, click No.
IoT FND lets you change the logging level for the various log categories and download the logs. Logs incur a certain amount of disk space. For example, for 5 million meters at an 8-hour reporting interval and 5000 routers at a 60-minute periodic inventory notification, disk consumption is approximately 7MB/sec. Ensure that your server has enough disk space to contain your logs.
To configure the logging level:
1. Choose ADMIN > System Management > Logging.
3. Check the check boxes of all logging categories to configure.
4. From the Change Log Level to drop-down menu, choose the logging level setting (Debug or Informational).
5. To apply the configuration, click Go.
1. Choose ADMIN > System Management > Logging.
2. Click the Download Logs tab.
3. Click the Download Logs button.
4. To download a zip file locally, click its file name.
Tip: In a cluster environment, if you need to send log files to Cisco Support, ensure that you send the log files of all cluster servers.
The Provisioning Settings page (ADMIN > System Management > Provisioning Settings) lets you configure the IoT FND URL, DHCPv4 Proxy Client, and DHCPv6 Proxy Client settings required for IoT FND to create tunnels between routers and ASRs (Provisioning Settings Page). See Zero Touch Deployment Architecture for an example of tunnels as used in the IoT FND architecture. See “Tunnel Provisioning Configuration Process for information on provisioning tunnels in the “Managing Tunnel Provisioning” chapter in the
I oT FND 4.0 Installation Guide. During ZTD, you can add DHCP calls to the device configuration template for leased IP addresses.
Note: For Red Hat Linux 7.x server installations, you must configure specific IPv4 and IPv6 addresses from the IoT FND Linux host server to which to bind DHCP IPv4 and IPv6 clients by setting the following values in IoT FND:
Note: To configure tunnel and proxy settings, you must be logged in either as root or as a user with Administrative Operations permissions.
Figure 3 Provisioning Settings Page
This section provides the following topics for configuring tunnel settings:
■Configuring the IoT FND Server URL
■Configuring DHCPv6 Proxy Client
■Configuring DHCPv4 Proxy Client
The IoT FND URL is the URL that routers use to access with IoT FND after the tunnel is established. This URL is also accessed during periodic inventories. During ZTD, routers transition from accessing IoT FND through the TPS proxy to using this URL, which must be appropriate for use through the tunnel.
1. Choose ADMIN > System Management > Provisioning Settings.
2. In the IoT FND URL field, enter the URL of the IoT FND server.
The URL must use the HTTPS protocol and include the port number designated to receive registration requests. By default, the port number is 9121. For example:
To configure DHCPv6 Proxy Client settings:
1. Choose ADMIN > System Management > Provisioning Settings.
2. Configure the DHCPv6 Proxy Client settings:
a. In the Server Address field, enter the address of the DHCPv6 server that provides tunnel IP addresses.
You can enter multiple addresses separated by commas. However, in most cases, you only need one server. IoT FND tries to get the tunnel IP addresses using DHCP protocols. If it cannot, it goes to the next server in the list and so on.
b. In the Server Port field, enter the port address on the DHCP server to send DHCPv6 requests.
Note: Do not change the default port number (547) unless you have configured your DHCP server to operate on a non-standard port.
c. In the Client Listen Address field, enter the address to bind to for DHCPv6 send and receive messages.
This is the address of the interface that the DHCP server uses to communicate with IoT FND. You can enter multiple backup addresses separated by commas.
Tip: For IoT FND installations where the host has multiple interfaces, the client sends requests using each listed source address. The default values, “0.0.0.0” (IPv4) and “::” (IPv6), cause the client to send requests out each interface. Usually, one interface faces the DHCP server(s). In these installations, setting the Client Listen Address field to the IP address of the facing interface sends all client requests out that interface.
To configure DHCPv4 Proxy Client settings:
1. Choose ADMIN > System Management > Provisioning Settings.
2. Configure the DHCPv4 Proxy Client settings:
a. In the Server Address field, enter the address of the DHCPv4 server that provides tunnel IP addresses.
You can enter multiple addresses separated by commas. However, in most cases, you only need one server. IoT FND tries to get the tunnel IP addresses from the first server in the list. If it cannot, it moves to the next server in the list, and so on.
b. In the Server Port field, enter the port address on the DHCP server to send DHCPv4 requests to.
Note: Do not change the default port number (67) unless you have configured your DHCP server to operate on a non-standard port.
c. In the Client Listen Address field, enter the address to bind to for send and receive DHCPv4 messages.
This is the address of the interface that the DHCP server uses to communicate with IoT FND. You can enter multiple backup addresses separated by commas.
The Server Settings page (ADMIN > System Management > Server Settings) lets you view and manage server settings.
■Configuring Download Logs Settings
■Configuring Device Down Timeouts
■Configuring Billing Period Settings
■Configuring the Issue Status Bar
Note: Configuring download log settings is only required for IoT FND cluster setup.
The Download Logs page lets you configure the Keystore settings.
To configure Download Logs settings:
1. Choose ADMIN > System Management > Server Settings.
2. Click the Download Logs tab.
The Web Sessions page lets you specify the number of timeout seconds after which IoT FND terminates web sessions and logs users out.
To configure web session timeout:
1. Choose ADMIN > System Management > Server Settings.
3. Enter the number of timeout seconds. Valid values are 0–86400 (24 hours).
If a web session is idle for the specified amount of time, IoT FND terminates the session and logs the user out.
The Device Down Timeouts page lets you specify the number of timeout seconds after which the status of Head-end routers (ASR) and Routers (CGR1000, IR800, C800, ESR) and Endpoints changes to Down in IoT FND. The device down poll interval is five minutes. The system uses the device down timeouts values and the last heard time to decide whether to change the device status to Down. For example, if the router device down timeout value is set to two hours (7200 seconds), all routers with a last heard time older than 2 hours are marked as status Down.
You can also configure the device timeout setting for router Config groups and Endpoint Config Groups.
Device status changes to Up when IoT FND detects any of the following:
■Periodic inventory notifications
To configure device down timeout settings:
1. Choose ADMIN > System Management > Server Settings.
2. Click the Device Down Timeouts tab.
3. For each device type listed, enter the number of seconds after which the device status changes to Down in IoT FND.
The parameter value must be greater than the corresponding polling intervals. For example, the default polling interval for endpoints is 8 hours (28800 seconds), so the value in the Mark {ACT | BACT | CAM | Cellular | IR500> Meter} Endpoints Down After (secs) field must be greater than 28800.
4. To save the configuration, click the disk icon.
Device Down Timeout Settings for Router Config Groups and Endpoint Config Groups
To configure device down timeout settings for Router Config groups or Endpoint Config Groups:
1. Choose CONFIG > Device Configuration.
2. Select the Device you want to configure { ROUTER | ENDPOINT} in the left pane.
3. Click the Group Properties tab.
4. In the Mark Routers Down After (secs) field, enter the number of seconds after which the status of the devices (router or endpoints) in the group changes to Down in IoT FND.
This value must be greater than the corresponding polling interval.
For example, the default polling interval for routers is 30 minutes (1800 seconds), so the value in the Mark Routers Down After (secs) field must be 1801 or greater.
The default polling interval for ENDPOINTS is 960 minutes (57600 seconds), so the value in the Mark Routers Down After (secs) field must be greater than 57600 seconds.
IoT FND lets you configure the start day of the monthly billing periods for cellular and Ethernet (satellite) services.
To configure the billing period settings: < NEED NUMBER SCRRENSHOT SEE IF SENT VIA SEP EMAIL>
1. Choose ADMIN > System Management > Server Settings.
2. Click the Billing Period Settings tab.
3. Enter the starting days for the cellular and Ethernet billing periods.
4. From the drop-down menu, choose the time zone for the billing period.
RPL tree polls are derived from router periodic notification events. Since the RPL tree is not pushed from the router with the periodic notification event, IoT FND must explicitly poll for the RPL tree at the configured intervals. IoT FND lets you configure the RPL tree polling cycle (that is, how many periodic notification events occur between RPL tree polls), and set the maximum amount of time between tree polls.
Caution: CG-NMS 1.1(5) release does not support router RPL tree updates. Do not enable RPL tree updates from Routers.
To configure RPL tree polling settings:
1. Choose ADMIN > System Management > Server Settings.
2. Choose the RPL Tree Settings tab.
3. Choose the Enable RPL tree update from radio button for Mesh Nodes to receive the RPL tree update from those devices.
The Issue Status bar displays issues by device type (as set in user preferences) and severity level in the lower-left browser frame.
To enable the Issue Status bar and configure the refresh interval:
1. Choose ADMIN > System Management > Sever Settings > Issue Settings.
2. To display the Issue status bar in the browser frame, check the Enable/Disable Issue Status Bar check box.
3. In the Issue Status Bar Refresh Interval (seconds) field, enter a refresh value in seconds.
■Valid values are 30 secs (default) to 300 secs (5 minutes). |
4. In the Certificate Expiry Threshold (days) field for all supported routers or an IoT FND application server, enter a value in days.
Note: When the configured Certificate Expiry Threshold default date is met, a Major event, certificateExpiration, is created. When the Certificate has expired (>180 days), a Critical event, certificateExpired, is created.
When IoT FND receives device events it stores them in its database and sends syslog messages to a syslog server that allows third-party application integration.
To configure Syslog forwarding:
1. Choose ADMIN > System Management > Syslog Settings.
2. In the Syslog Server IP Address field, enter the IP address of the Syslog server.
3. In the Syslog Server Port Number field, enter the port number (default is 514) over which to receive device events.
■To enable message forwarding to the Syslog server, click Enable Syslog Sending Events. |
■To disable message forwarding to the Syslog server, click Disable Syslog Sending Events. |
For IoT FND cluster solutions, each server in the cluster sends events to the same Syslog server.