Skip to content

Commit af29bf0

Browse files
authored
Update method list in cp_methods_reference.md
1 parent 49ee44e commit af29bf0

1 file changed

Lines changed: 184 additions & 175 deletions

File tree

cp_methods_reference.md

Lines changed: 184 additions & 175 deletions
Original file line numberDiff line numberDiff line change
@@ -4,181 +4,190 @@ This document lists all available methods when importing the `cp` module for NCO
44

55
## Quick Index (A–Z)
66

7-
- `add_advanced_apn`
8-
- `alert`
9-
- `clear_dns_cache`
10-
- `clear_logs`
11-
- `clean_up_reg`
12-
- `create_user`
13-
- `dec`
14-
- `delete`
15-
- `delete_advanced_apn`
16-
- `delete_appdata`
17-
- `delete_user`
18-
- `decrypt`
19-
- `disable_wan_device`
20-
- `dns_lookup`
21-
- `download_packet_capture`
22-
- `enable_wan_device`
23-
- `ensure_fresh_user`
24-
- `ensure_user_exists`
25-
- `execute_cli`
26-
- `extract_cert_and_key`
27-
- `factory_reset`
28-
- `get`
29-
- `get_all_gpios`
30-
- `get_appdata`
31-
- `get_apps_status`
32-
- `get_arp_table`
33-
- `get_asset_id`
34-
- `get_available_gpios`
35-
- `get_available_interfaces`
36-
- `get_bgp_status`
37-
- `get_certificate_by_name`
38-
- `get_certificate_by_uuid`
39-
- `get_certificate_status`
40-
- `get_certificate_summary`
41-
- `get_certificates`
42-
- `get_client_usage`
43-
- `get_comprehensive_status`
44-
- `get_description`
45-
- `get_dhcp_client_by_ip`
46-
- `get_dhcp_client_by_mac`
47-
- `get_dhcp_clients_by_interface`
48-
- `get_dhcp_clients_by_network`
49-
- `get_dhcp_interface_summary`
50-
- `get_dhcp_leases`
51-
- `get_dns_status`
52-
- `get_event_status`
53-
- `get_expiring_certificates`
54-
- `get_firewall_connections`
55-
- `get_firewall_connections_by_ip`
56-
- `get_firewall_connections_by_protocol`
57-
- `get_firewall_hitcounters`
58-
- `get_firewall_marks`
59-
- `get_firewall_state_timeouts`
60-
- `get_firewall_status`
61-
- `get_flow_statistics`
62-
- `get_firmware_version`
63-
- `get_gpio`
64-
- `get_gps_status`
65-
- `get_iot_status`
66-
- `get_ipv4_lan_clients`
67-
- `get_ipv4_wifi_clients`
68-
- `get_ipv4_wired_clients`
69-
- `get_lan_clients`
70-
- `get_lan_device_stats`
71-
- `get_lan_devices`
72-
- `get_lan_networks`
73-
- `get_lan_statistics`
74-
- `get_lan_status`
75-
- `get_logger`
76-
- `get_mac`
77-
- `get_ncm_account_name`
78-
- `get_ncm_api_keys`
79-
- `get_ncm_group_name`
80-
- `get_ncm_router_id`
81-
- `get_name`
82-
- `get_obd_status`
83-
- `get_openvpn_status`
84-
- `get_ospf_status`
85-
- `get_poe_status`
86-
- `get_power_usage`
87-
- `get_product_type`
88-
- `get_qos_queue_by_name`
89-
- `get_qos_queues`
90-
- `get_qos_status`
91-
- `get_qos_traffic_stats`
92-
- `get_raw_gpios`
93-
- `get_route_summary`
94-
- `get_router_model`
95-
- `get_routing_policies`
96-
- `get_routing_table`
97-
- `get_routing_table_by_name`
98-
- `get_sdwan_status`
99-
- `get_security_status`
100-
- `get_services_status`
101-
- `get_signal_strength`
102-
- `get_sims`
103-
- `get_sensors_status`
104-
- `get_static_routes`
105-
- `get_storage_status`
106-
- `get_system_status`
107-
- `get_temperature`
108-
- `get_usb_status`
109-
- `get_users`
110-
- `get_vpn_status`
111-
- `get_wan_connection_state`
112-
- `get_wan_devices`
113-
- `get_wan_devices_status`
114-
- `get_wan_device_profile`
115-
- `get_wan_device_summary`
116-
- `get_wan_ethernet_info`
117-
- `get_wan_ip_address`
118-
- `get_wan_modem_diagnostics`
119-
- `get_wan_modem_stats`
120-
- `get_wan_primary_device`
121-
- `get_wan_profile_by_name`
122-
- `get_wan_profile_by_trigger_string`
123-
- `get_wan_profiles`
124-
- `get_wan_status`
125-
- `get_wlan_channel_info`
126-
- `get_wlan_client_count`
127-
- `get_wlan_client_count_by_band`
128-
- `get_wlan_clients`
129-
- `get_wlan_debug`
130-
- `get_wlan_events`
131-
- `get_wlan_radio_by_band`
132-
- `get_wlan_radio_status`
133-
- `get_wlan_region_config`
134-
- `get_wlan_remote_status`
135-
- `get_wlan_state`
136-
- `get_wlan_status`
137-
- `get_wlan_trace`
138-
- `log`
139-
- `make_wan_device_highest_priority`
140-
- `monitor_log`
141-
- `monitor_sms`
142-
- `network_connectivity_test`
143-
- `packet_capture`
144-
- `ping_host`
145-
- `post`
146-
- `post_appdata`
147-
- `put`
148-
- `put_appdata`
149-
- `reboot_device`
150-
- `register`
151-
- `remove_manual_apn`
152-
- `reorder_wan_profiles`
153-
- `reset_modem`
154-
- `reset_wlan`
155-
- `restart_service`
156-
- `send_sms`
157-
- `set_asset_id`
158-
- `set_description`
159-
- `set_log_level`
160-
- `set_manual_apn`
161-
- `set_name`
162-
- `set_wan_device_bandwidth`
163-
- `set_wan_device_default_connection_state`
164-
- `set_wan_device_priority`
165-
- `speed_test`
166-
- `start_file_server`
167-
- `start_packet_capture`
168-
- `start_streaming_capture`
169-
- `stop_monitor_log`
170-
- `stop_monitor_sms`
171-
- `stop_packet_capture`
172-
- `stop_ping`
173-
- `stop_speed_test`
174-
- `traceroute_host`
175-
- `unregister`
176-
- `uptime`
177-
- `wait_for_gps_fix`
178-
- `wait_for_modem_connection`
179-
- `wait_for_ntp`
180-
- `wait_for_uptime`
181-
- `wait_for_wan_connection`
7+
- cp.add_advanced_apn()
8+
- cp.alert()
9+
- cp.base64()
10+
- cp.clear_dns_cache()
11+
- cp.clear_logs()
12+
- cp.create_user()
13+
- cp.datetime()
14+
- cp.decrypt()
15+
- cp.delete()
16+
- cp.delete_advanced_apn()
17+
- cp.delete_appdata()
18+
- cp.delete_user()
19+
- cp.disable_wan_device()
20+
- cp.dns_lookup()
21+
- cp.download_packet_capture()
22+
- cp.enable_wan_device()
23+
- cp.ensure_fresh_user()
24+
- cp.ensure_user_exists()
25+
- cp.execute_cli()
26+
- cp.extract_cert_and_key()
27+
- cp.factory_reset()
28+
- cp.get()
29+
- cp.get_all_gpios()
30+
- cp.get_appdata()
31+
- cp.get_apps_status()
32+
- cp.get_arp_table()
33+
- cp.get_asset_id()
34+
- cp.get_available_gpios()
35+
- cp.get_available_interfaces()
36+
- cp.get_bgp_status()
37+
- cp.get_certificate_by_name()
38+
- cp.get_certificate_by_uuid()
39+
- cp.get_certificate_status()
40+
- cp.get_certificate_summary()
41+
- cp.get_certificates()
42+
- cp.get_client_usage()
43+
- cp.get_comprehensive_status()
44+
- cp.get_connected_wans()
45+
- cp.get_description()
46+
- cp.get_dhcp_client_by_ip()
47+
- cp.get_dhcp_client_by_mac()
48+
- cp.get_dhcp_clients_by_interface()
49+
- cp.get_dhcp_clients_by_network()
50+
- cp.get_dhcp_interface_summary()
51+
- cp.get_dhcp_leases()
52+
- cp.get_dhcp_status()
53+
- cp.get_dns_status()
54+
- cp.get_event_status()
55+
- cp.get_expiring_certificates()
56+
- cp.get_firewall_connections()
57+
- cp.get_firewall_connections_by_ip()
58+
- cp.get_firewall_connections_by_protocol()
59+
- cp.get_firewall_hitcounters()
60+
- cp.get_firewall_marks()
61+
- cp.get_firewall_state_timeouts()
62+
- cp.get_firewall_status()
63+
- cp.get_firewall_summary()
64+
- cp.get_firmware_version()
65+
- cp.get_flow_statistics()
66+
- cp.get_gpio()
67+
- cp.get_gps_status()
68+
- cp.get_hotspot_status()
69+
- cp.get_iot_status()
70+
- cp.get_ipv4_lan_clients()
71+
- cp.get_ipv4_wifi_clients()
72+
- cp.get_ipv4_wired_clients()
73+
- cp.get_lan_clients()
74+
- cp.get_lan_device_stats()
75+
- cp.get_lan_devices()
76+
- cp.get_lan_networks()
77+
- cp.get_lan_statistics()
78+
- cp.get_lan_status()
79+
- cp.get_lat_long()
80+
- cp.get_logger()
81+
- cp.get_mac()
82+
- cp.get_name()
83+
- cp.get_ncm_account_name()
84+
- cp.get_ncm_api_keys()
85+
- cp.get_ncm_group_name()
86+
- cp.get_ncm_router_id()
87+
- cp.get_ncm_status()
88+
- cp.get_obd_status()
89+
- cp.get_openvpn_status()
90+
- cp.get_ospf_status()
91+
- cp.get_packet_capture_status()
92+
- cp.get_poe_status()
93+
- cp.get_power_usage()
94+
- cp.get_product_type()
95+
- cp.get_qos_queue_by_name()
96+
- cp.get_qos_queues()
97+
- cp.get_qos_status()
98+
- cp.get_qos_traffic_stats()
99+
- cp.get_route_summary()
100+
- cp.get_router_model()
101+
- cp.get_routing_policies()
102+
- cp.get_routing_table()
103+
- cp.get_routing_table_by_name()
104+
- cp.get_sdwan_status()
105+
- cp.get_security_status()
106+
- cp.get_sensors_status()
107+
- cp.get_serial_number()
108+
- cp.get_services_status()
109+
- cp.get_signal_strength()
110+
- cp.get_sims()
111+
- cp.get_static_routes()
112+
- cp.get_storage_status()
113+
- cp.get_system_status()
114+
- cp.get_temperature()
115+
- cp.get_uptime()
116+
- cp.get_usb_status()
117+
- cp.get_users()
118+
- cp.get_vpn_status()
119+
- cp.get_wan_connection_state()
120+
- cp.get_wan_device_profile()
121+
- cp.get_wan_device_summary()
122+
- cp.get_wan_devices()
123+
- cp.get_wan_devices_status()
124+
- cp.get_wan_ethernet_info()
125+
- cp.get_wan_ip_address()
126+
- cp.get_wan_modem_diagnostics()
127+
- cp.get_wan_modem_stats()
128+
- cp.get_wan_primary_device()
129+
- cp.get_wan_profile_by_name()
130+
- cp.get_wan_profile_by_trigger_string()
131+
- cp.get_wan_profiles()
132+
- cp.get_wan_status()
133+
- cp.get_wlan_channel_info()
134+
- cp.get_wlan_client_count()
135+
- cp.get_wlan_client_count_by_band()
136+
- cp.get_wlan_clients()
137+
- cp.get_wlan_debug()
138+
- cp.get_wlan_events()
139+
- cp.get_wlan_radio_by_band()
140+
- cp.get_wlan_radio_status()
141+
- cp.get_wlan_region_config()
142+
- cp.get_wlan_remote_status()
143+
- cp.get_wlan_state()
144+
- cp.get_wlan_status()
145+
- cp.get_wlan_trace()
146+
- cp.log()
147+
- cp.make_wan_device_highest_priority()
148+
- cp.monitor_log()
149+
- cp.monitor_sms()
150+
- cp.network_connectivity_test()
151+
- cp.on()
152+
- cp.packet_capture()
153+
- cp.ping_host()
154+
- cp.post()
155+
- cp.post_appdata()
156+
- cp.put()
157+
- cp.put_appdata()
158+
- cp.reboot_device()
159+
- cp.register()
160+
- cp.remove_manual_apn()
161+
- cp.reorder_wan_profiles()
162+
- cp.reset_modem()
163+
- cp.reset_wlan()
164+
- cp.send_sms()
165+
- cp.set_asset_id()
166+
- cp.set_description()
167+
- cp.set_log_level()
168+
- cp.set_manual_apn()
169+
- cp.set_name()
170+
- cp.set_wan_device_bandwidth()
171+
- cp.set_wan_device_default_connection_state()
172+
- cp.set_wan_device_priority()
173+
- cp.speed_test()
174+
- cp.start_file_server()
175+
- cp.start_packet_capture()
176+
- cp.start_streaming_capture()
177+
- cp.stop_monitor_log()
178+
- cp.stop_monitor_sms()
179+
- cp.stop_packet_capture()
180+
- cp.stop_ping()
181+
- cp.stop_speed_test()
182+
- cp.time()
183+
- cp.traceroute_host()
184+
- cp.unregister()
185+
- cp.uptime()
186+
- cp.wait_for_gps_fix()
187+
- cp.wait_for_modem_connection()
188+
- cp.wait_for_ntp()
189+
- cp.wait_for_uptime()
190+
- cp.wait_for_wan_connection()
182191

183192
## Core Communication Methods
184193

0 commit comments

Comments
 (0)