Config CLI Entities

The config shell allows the user to configure a number of fields which are the settings for the device. These fields are grouped in entities that describe a small set of functionality. For example, there is a ‘user’ entity which is used to access user settings. Entities can contain sub-entities as well as simple fields.

Once in the shell, a number of commands are available depending on the current context. The context is the current entity that is the focus of the config shell. When the shell is first started, the context is a special parent context from which sub-entities can be seen.

Once a context is selected by typing the name of the entity, it is shown in the prompt between brackets. e.g. In the following snippet, the ‘user’ context is accessed and then the ‘john’ sub-entity is accessed causing the context to become ‘user john’. The ‘show’ command is used to list the entities and fields that descend from the current context.

Supported Entities

Entity	Definition
access_right	An access right is a permit that grants the holder access to a feature or collection of related features.
auth	Configure remote authentication, authorization, accounting (AAA) servers.
auto_response/beacon	Read and manipulate the Auto-Response beacons on the NetOps Console Server appliance.
auto_response/reaction	Read and manipulate the Auto-Response reactions on the NetOps Console Server appliance.
auto_response/status	Read the AutoResponse Status on the NetOps Console Server appliance.
auto_response/status/ beacon-module	Read the AutoResponse Status of Beacon Modules on the NetOps Console Server appliance.
cellfw/info	Retrieve cellular modem version and related information.
cellmodem	Retrieve information about the cell modem.
cellmodem/sim	Cell modem SIM status.
conn	Read and manipulate the network connections on the NetOps Console Server appliance.
diff	config diff performs a comparison of the active configuration and an input configuration file, which is the product of the ogcli export <template-file> operation. Config diff shows additions, removals and changes clearly in the a streamlined format with only functional differences between the input and running configurations. See also ogcli diff.
failover/settings	failover/settings endpoint is to check and update failover settings. When failover is enabled, this device will consume from 1MB to 1.6 MB of bandwidth per day on the probe_physif connection. If the probe addresses are unreachable, this device will take from 108 to 156 seconds to enter the failover state.
failover/status	failover/status endpoint is to check current failover status.
firewall/policy	A collection of policies defined for the NetOps Console Server appliance's firewall. A policy specifies which zones traffic is allowed to route between.
firewall/predefined_service	A collection of predefined services for the NetOps Console Server appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. This collection contains predefined services for common protocols and doesn't include the services added by the administrator.
firewall/service	A collection of custom services defined for the NetOps Console Server appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. The appliance includes many predefined services for common protocols (see /firewall/predefined_services). This collection contains only custom services which have been defined by the administrator.
firewall/zone	Collection of zones defined for the NetOps Console Server appliance's firewall. A zone includes 1 or more interfaces.
group	Retrieve or update user group information
ip_passthrough	IP Passthrough endpoints are for retrieving / changing IP Passthrough settings.
ip_passthrough/status	The IP Passthrough status endpoint provides information about what part of the IP Passthrough connection process the device is currently at and information about the connected downstream device.
ipsec_tunnel	Read and manipulate the IPsec tunnels on the NetOps Console Server appliance.
lighthouse_enrollment	View and control enrollment to a lighthouse.
local_password_policy	Configure the password policy for local users. This includes expiry and complexity settings.
logs/portlog	None
logs/portlog_settings	Check and update port log settings.
managementport	Used for working with local management console information
monitor/brute_force_protection/ban	Used for monitoring addresses banned by Brute Force Protection.
monitor/lldp/chassis	Get the current status of the network discovery (LLDP/CDP) protocols on this device.
monitor/lldp/neighbor	Get the list of neighboring devices (peers) that have been discovered by the LLDP protocol.
monitor/static_routes/ status	Used for monitoring the status of static routes. Only IPv4 static routes are supported.
monitoring/ alerts/networking	Retrieve and configure Networking Alert Group settings.
monitoring/alerts/power	Retrieve and configure Power Alert Group settings.
monitoring/alerts/system	Retrieve and configure System Alert Group settings.
pdu	Configure, monitor and control PDUs connected to the device.
pdus/drivers	Read the PDU driver list.
physif	Read and manipulate the network physical interfaces on the NetOps Console Server appliance.
port	Configuring and viewing ports information
port_session	None
ports/ auto_discover/schedule	Manage Port Auto-Discovery Scheduling
ports/status_port	Provides information about the serial pin status and Tx & Rx counters for each of this device's serial ports
system/admin_info	Retrieve or change the appliance system's information (hostname, contact and location)
services/ brute_force_protection	Provides access to the Brute Force Protection configuration on the system. When this service is enabled, the system watches for multiple failed login attempts and temporarily bans the offending IP Address for the configured amount of time.
services/lldp	Provides access to the Network Discovery Protocols (LLDP/CDP) configuration.
services/ntp	Provides access to the NTP client configuration on the system.
services/routing	Retrieve and configure routing services on the NetOps Console Server appliance.
services/ snmp_alert_manager	SNMP Alert Managers are used to receive and log SNMP TRAP and INFORM messages sent by the NetOps Console Server. To receive SNMP alerts generated by the system at least one SNMP Alert Manager must be configured.
services/snmpd	Simple Network Management Protocol (SNMP) is an Internet Standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behaviour. This entity allows configuration of the SNMP service.
services/ssh	Configure the Secure Shell Protocol (SSH) service.
services/syslog_server	Provides access to the remote syslog server configuration.
services/tftp	Trivial File Transfer Protocol (TFTP) is a service that allows files to be transferred to or from the NetOps Console Server appliance. This entity provides access to the TFTP server configuration on the system.
single_session	Can be enabled on a given port to prevent multiple users from connecting to that port or limit the port to a single concurrent connection.
ssh/authorized_key	Configure the SSH authorized keys for a specific user.
static_route	Configuring and viewing static routes.
system/admin_info	Retrieve or change the NetOps Console Server appliance system's information (hostname, contact and location).
system/banner	Retrieve or change the appliance system's banner text
system/cell_reliability_test	None
system/cellular_logging	Cellular logging provides the ability to capture the RRC connection messages from the EM7565 cellular module. This entity allows configuration of cellular logging and is only to be used during compliance testing.
system/cloud_connect	Retrieve or change the appliance system's cloud connect configuration
system/diskspace	Retrieve the system's Disk Space usage.
system/info	Retrieve basic system information.
system/model_name	Retrieve the appliance's Model Name
system/serial_number	Retrieve the appliance's Serial Number
system/session_timeout	Retrieve or change the appliance session timeouts
system/ssh_port	The SSH port used in Direct SSH links
system/ system_authorized_key	Configure the SSH authorized keys for all users.
system/time	Retrieve and update the NetOps Console Server's time.
system/timezone	Retrieve and update the system's timezone.
system/version	Retrieve the appliance's most recent firmware and REST API version
user	Retrieve and update user information