PortivoDocs · v2.0.0Complete handbookportivo.orgGitHub
Reference

Action catalog

All 149 action catalog entries in v2.0.0.

v2.0.0Source-backed

The catalog is the operator-facing action reference. Execution is additionally constrained by AOS profile, compatibility metadata, learned per-device evidence, role capabilities and exact action policy.

KeyLabelCategoryRiskInputsDescriptionCompatibility
system_infoSystem informationSystemreadnoneModel, AOS release and system identity.Model and AOS support may vary
hardware_infoHardware informationSystemreadnoneHardware, bootloader and FPGA information.Model and AOS support may vary
health_statusSystem healthSystemreadnoneOverall switch health summary.Model and AOS support may vary
chassis_statusChassis statusSystemreadnoneChassis, CMM and module state.Model and AOS support may vary
module_statusModule statusSystemreadnoneInstalled modules and operational state.Model and AOS support may vary
power_supplyPower suppliesSystemreadnonePower supply inventory and state.Model and AOS support may vary
temperature_statusTemperature sensorsSystemreadnoneTemperature readings and thresholds.Model and AOS support may vary
fan_statusFan statusSystemreadnoneFan inventory and operational state.Model and AOS support may vary
cpu_statusCPU utilizationSystemreadnoneProcessor utilization and load.Model and AOS support may vary
memory_statusMemory utilizationSystemreadnoneMemory use and availability.Model and AOS support may vary
clock_statusSystem clockSystemreadnoneCurrent switch date and time.Model and AOS support may vary
running_directoryRunning directorySystemreadnoneCurrent boot and running directory.Model and AOS support may vary
certified_directoryCertified directorySystemreadnoneCertified software directory state.Model and AOS support may vary
working_directoryWorking directorySystemreadnoneWorking software directory state.Model and AOS support may vary
configuration_statusConfiguration statusSystemreadnoneConfiguration synchronization and directory status.Model and AOS support may vary
configuration_snapshotConfiguration snapshotConfigurationreadnoneCurrent configuration snapshot.Model and AOS support may vary
license_statusLicensesSystemreadnoneInstalled licenses and entitlement state.Model and AOS support may vary
microcode_statusMicrocodeSystemreadnoneInstalled software and microcode packages.Model and AOS support may vary
reload_statusReload statusSystemreadnoneScheduled reload and reboot information.Model and AOS support may vary
session_statusCLI sessionsSystemreadnoneActive management sessions.Model and AOS support may vary
directory_listingFile system directorySystemreadnoneFiles in the current switch directory.Model and AOS support may vary
tech_supportTechnical support bundleDiagnosticsreadnoneCollect broad read-only diagnostic output. This can be large.Model and AOS support may vary
software_logSoftware logDiagnosticsreadnoneSwitch software event log.Model and AOS support may vary
command_logCommand logDiagnosticsreadnoneRecent CLI command activity.Model and AOS support may vary
log_configurationLogging configurationDiagnosticsreadnoneConfigured logging destinations and severity.Model and AOS support may vary
sflow_statussFlow statusDiagnosticsreadnonesFlow configuration and collectors.Model and AOS support may vary
rmon_statusRMON statusDiagnosticsreadnoneRemote monitoring configuration and statistics.Model and AOS support may vary
port_monitoringPort monitoringDiagnosticsreadnonePort mirroring and monitoring sessions.Model and AOS support may vary
amap_statusAMAP topologyDiagnosticsreadnoneAlcatel Mapping Adjacency Protocol neighbors.Model and AOS support may vary
loopback_detectionLoopback detectionDiagnosticsreadnoneLoopback detection state and events.Model and AOS support may vary
users_statusLocal user accountsSecurityreadnoneConfigured local management users.Model and AOS support may vary
aaa_statusAAA authenticationSecurityreadnoneAuthentication methods and order.Model and AOS support may vary
ssh_statusSSH serviceSecurityreadnoneSSH service configuration and state.Model and AOS support may vary
telnet_statusTelnet serviceSecurityreadnoneTelnet service configuration and state.Model and AOS support may vary
http_statusWeb management serviceSecurityreadnoneHTTP and HTTPS management service state.Model and AOS support may vary
snmp_statusSNMP stationsSecurityreadnoneSNMP managers and station configuration.Model and AOS support may vary
snmp_communitySNMP community mappingSecurityreadnoneSNMP community mappings.Model and AOS support may vary
ntp_statusNTP serversSecurityreadnoneConfigured NTP servers and state.Model and AOS support may vary
dns_statusDNS configurationSecurityreadnoneDNS client and name-server configuration.Model and AOS support may vary
ip_servicesIP servicesSecurityreadnoneManagement IP services and source interfaces.Model and AOS support may vary
radius_statusRADIUS serversSecurityreadnoneConfigured RADIUS servers.Model and AOS support may vary
tacacs_statusTACACS serversSecurityreadnoneConfigured TACACS+ servers.Model and AOS support may vary
dot1x_status802.1X statusSecurityreadnone802.1X global and port state.Model and AOS support may vary
dot1x_users802.1X usersSecurityreadnoneAuthenticated 802.1X sessions.Model and AOS support may vary
port_securityPort securitySecurityreadnonePort security state and learned addresses.Model and AOS support may vary
ip_source_guardIP source guardSecurityreadnoneIP source guard bindings and state.Model and AOS support may vary
dhcp_snoopingDHCP snoopingSecurityreadnoneDHCP snooping configuration and bindings.Model and AOS support may vary
macsec_statusMACsec statusSecurityreadnoneMACsec interfaces and secure channels.AOS8 and supported hardware
interface_detail_allAll interface detailsInterfacesreadnoneDetailed information for all interfaces.Model and AOS support may vary
interface_status_allAll interface statusInterfacesreadnoneAdministrative and operational state for every interface.Model and AOS support may vary
interface_counters_allAll interface countersInterfacesreadnoneTraffic counters for all interfaces.Model and AOS support may vary
interface_errorsInterface error countersInterfacesreadnoneError counters for all interfaces.Model and AOS support may vary
interface_transceiversAll transceiversInterfacesreadnoneOptical and copper transceiver inventory.Model and AOS support may vary
interface_capabilitiesInterface capabilitiesInterfacesreadnoneAdvertised and supported interface capabilities.Model and AOS support may vary
interface_autonegAuto-negotiation statusInterfacesreadnoneAuto-negotiation state for interfaces.Model and AOS support may vary
interface_flow_controlFlow control statusInterfacesreadnoneEthernet flow-control state.Model and AOS support may vary
interface_statusInterface statusInterfacesreadportState for one interface.Model and AOS support may vary
interface_detailsInterface detailsInterfacesreadportDetailed information for one interface.Model and AOS support may vary
interface_countersInterface countersInterfacesreadportTraffic counters for one interface.Model and AOS support may vary
interface_transceiverInterface transceiverInterfacesreadportTransceiver diagnostics for one interface.Model and AOS support may vary
interface_enableEnable interfaceInterfaceschangeportAdministratively enable one interface.Model and AOS support may vary
interface_disableDisable interfaceInterfaceschangeportAdministratively disable one interface.Model and AOS support may vary
interface_aliasSet interface aliasInterfaceschangeport, aliasAssign a readable alias to one interface.Model and AOS support may vary
link_aggregationLink aggregation groupsInterfacesreadnoneConfigured link aggregation groups.Model and AOS support may vary
linkagg_portsLink aggregation portsInterfacesreadnonePorts participating in link aggregation.Model and AOS support may vary
linkagg_sizeLink aggregation sizesInterfacesreadnoneConfigured aggregation sizes and limits.Model and AOS support may vary
ethernet_oamEthernet OAMInterfacesreadnoneEthernet operations, administration and maintenance state.Model and AOS support may vary
udld_statusUDLD statusInterfacesreadnoneUniDirectional Link Detection state.Model and AOS support may vary
poe_global_statusPoE global statusPower over EthernetreadnoneGlobal lanpower service, budget and consumption.Model and AOS support may vary
poe_statusPoE slot statusPower over EthernetreadslotPoE service and budget for a slot.Model and AOS support may vary
poe_port_statusPoE port statusPower over EthernetreadportPower state and consumption for one port.Model and AOS support may vary
poe_enableEnable PoE portPower over EthernetchangeportAdministratively enable PoE on one port.Model and AOS support may vary
poe_disableDisable PoE portPower over EthernetchangeportAdministratively disable PoE on one port.Model and AOS support may vary
poe_slot_startStart PoE slot servicePower over EthernetchangeslotStart PoE service for a slot.AOS8
poe_slot_stopStop PoE slot servicePower over EthernetchangeslotStop PoE service for a slot.AOS8
unp_usersUNP usersUNPreadnoneAuthenticated and classified UNP users.Model and AOS support may vary
unp_portsUNP portsUNPreadnoneUNP state and assignment by port.Model and AOS support may vary
unp_port_configUNP port configurationUNPreadnoneConfigured UNP attributes on ports.Model and AOS support may vary
unp_profilesUNP profilesUNPreadnoneConfigured User Network Profiles.Model and AOS support may vary
unp_classificationUNP classificationUNPreadnoneUNP classification rules and methods.Model and AOS support may vary
unp_globalUNP global configurationUNPreadnoneGlobal UNP configuration.Model and AOS support may vary
unp_port_templatesUNP port templatesUNPreadnoneConfigured UNP port templates.Model and AOS support may vary
unp_authenticationUNP authenticationUNPreadnoneUNP authentication configuration and state.Model and AOS support may vary
unp_vlanUNP VLAN assignmentsUNPreadnoneVLAN assignments created through UNP.Model and AOS support may vary
unp_edge_profilesUNP edge profilesUNPreadnoneConfigured UNP edge profiles.Model and AOS support may vary
mac_tableMAC address tableLayer 2readnoneALE source-learning table with learned MAC addresses, VLAN/service context and interfaces.Model and AOS support may vary
mac_countMAC address countLayer 2readnoneALE source-learning view including the switch-reported total valid MAC count.Model and AOS support may vary
mac_learnedLearned MAC addressesLayer 2readnoneDynamically learned MAC addresses from the ALE source-learning table.Model and AOS support may vary
arp_tableARP tableLayer 2readnoneIPv4 to MAC mappings.Model and AOS support may vary
lldp_neighborsLLDP neighborsLayer 2readnoneRemote LLDP neighbors.Model and AOS support may vary
lldp_localLLDP local systemLayer 2readnoneLocal LLDP system information.Model and AOS support may vary
lldp_policyLLDP network policiesLayer 2readnoneLLDP-MED network policies.Model and AOS support may vary
vlan_summaryVLAN summaryLayer 2readnoneConfigured VLANs and state.Model and AOS support may vary
vlan_portsVLAN port membershipLayer 2readnoneVLAN membership by port.Model and AOS support may vary
vlan_membersVLAN membersLayer 2readnoneTagged and untagged VLAN membership.Model and AOS support may vary
spanning_treeSpanning TreeLayer 2readnoneSpanning Tree state and topology.Model and AOS support may vary
spanning_tree_portsSpanning Tree portsLayer 2readnoneSpanning Tree state by port.Model and AOS support may vary
spanning_tree_mstMST instancesLayer 2readnoneMultiple Spanning Tree instances.Model and AOS support may vary
mvrp_statusMVRP statusLayer 2readnoneMultiple VLAN Registration Protocol state.Model and AOS support may vary
ip_interfacesIPv4 interfacesLayer 3readnoneConfigured IPv4 interfaces.Model and AOS support may vary
ip_routesIPv4 routing tableLayer 3readnoneCurrent IPv4 routes.Model and AOS support may vary
ip_route_summaryIPv4 route summaryLayer 3readnoneRoute totals and protocol summary.Model and AOS support may vary
ip_protocolsIPv4 protocolsLayer 3readnoneEnabled IP routing protocols.Model and AOS support may vary
ip_helpersIP helper addressesLayer 3readnoneConfigured helper and relay addresses.Model and AOS support may vary
ipv6_interfacesIPv6 interfacesLayer 3readnoneConfigured IPv6 interfaces.Model and AOS support may vary
ipv6_routesIPv6 routing tableLayer 3readnoneCurrent IPv6 routes.Model and AOS support may vary
ospf_statusOSPF statusLayer 3readnoneOSPF process and area state.Model and AOS support may vary
ospf_neighborsOSPF neighborsLayer 3readnoneOSPF neighbor adjacencies.Model and AOS support may vary
ospf_interfacesOSPF interfacesLayer 3readnoneOSPF state by interface.Model and AOS support may vary
bgp_statusBGP statusLayer 3readnoneBGP process and routing state.Model and AOS support may vary
bgp_neighborsBGP neighborsLayer 3readnoneBGP peer sessions.Model and AOS support may vary
rip_statusRIP statusLayer 3readnoneRIP process state.Model and AOS support may vary
vrf_statusVRF statusLayer 3readnoneVirtual routing and forwarding instances.Model and AOS support may vary
multicast_pimPIM statusLayer 3readnoneProtocol Independent Multicast state.Model and AOS support may vary
multicast_routesMulticast routing tableLayer 3readnoneIPv4 multicast routes.Model and AOS support may vary
dhcp_relayDHCP relayLayer 3readnoneDHCP relay configuration and counters.Model and AOS support may vary
qos_configQoS configurationQoS and PolicyreadnoneGlobal QoS configuration.Model and AOS support may vary
qos_statisticsQoS statisticsQoS and PolicyreadnoneQoS counters and statistics.Model and AOS support may vary
qos_policyQoS policiesQoS and PolicyreadnoneConfigured QoS policies.Model and AOS support may vary
policy_conditionPolicy conditionsQoS and PolicyreadnoneConfigured policy conditions.Model and AOS support may vary
policy_actionPolicy actionsQoS and PolicyreadnoneConfigured policy actions.Model and AOS support may vary
policy_rulePolicy rulesQoS and PolicyreadnoneConfigured policy rules.Model and AOS support may vary
policy_servicePolicy servicesQoS and PolicyreadnoneConfigured policy services.Model and AOS support may vary
policy_network_groupPolicy network groupsQoS and PolicyreadnoneConfigured policy network groups.Model and AOS support may vary
policy_listPolicy listsQoS and PolicyreadnoneConfigured policy lists.Model and AOS support may vary
access_listAccess listsQoS and PolicyreadnoneConfigured access lists.Model and AOS support may vary
ip_access_listIPv4 access listsQoS and PolicyreadnoneConfigured IPv4 access lists.Model and AOS support may vary
ipv6_access_listIPv6 access listsQoS and PolicyreadnoneConfigured IPv6 access lists.Model and AOS support may vary
vc_statusVirtual Chassis statusFabric and VCreadnoneVirtual Chassis state and roles.AOS8
vc_topologyVirtual Chassis topologyFabric and VCreadnoneVirtual Chassis topology and links.AOS8
vc_consistencyVirtual Chassis consistencyFabric and VCreadnoneConfiguration consistency across the chassis.AOS8
vc_vflVirtual Chassis VFLFabric and VCreadnoneVirtual fabric link state.AOS8
automatic_fabricAutomatic fabricFabric and VCreadnoneAutomatic fabric configuration and state.AOS8
spb_statusSPB statusFabric and VCreadnoneShortest Path Bridging state.AOS8
spb_isisSPB IS-ISFabric and VCreadnoneSPB IS-IS database and state.AOS8
spb_adjacencySPB adjacenciesFabric and VCreadnoneSPB IS-IS adjacencies.AOS8
service_statusServicesFabric and VCreadnoneConfigured Ethernet services.AOS8
service_accessService accessFabric and VCreadnoneService access ports and bindings.AOS8
service_sapService access pointsFabric and VCreadnoneConfigured service access points.AOS8
save_configSave configurationConfigurationchangenoneWrite the active configuration to persistent storage.Model and AOS support may vary
interface_cycleRestart interfaceInterfaceschangeport, delayDisable an interface, wait for the selected time, then enable it and verify state.AOS6 and AOS8
poe_cycleRestart PoE portPower over Ethernetchangeport, delayDisable lanpower, wait for the selected time, then enable it and verify power state.AOS6 and AOS8
custom_commandCustom CLI consoleAdvancedchangenoneRun one or more manually entered AOS commands with preview, confirmation and audit logging.Depends on switch model, AOS release and licenses
check_unpCheck UNPUNPreadnoneScan selected switches for GUEST with VOIP or IPTV on the same non-protected port without changing any interface.AOS8. Uses show unp user and the configured UNP conflict rules
fix_unpFix UNPUNPchangedelayDetect GUEST with VOIP or IPTV on the same non-protected port, then restart only the affected interfaces.AOS8. Uses show unp user and interface restart safeguards
vlan_port_maintenanceVLAN Port MaintenanceLayer 2changedelayDiscover access ports for a target VLAN, protect uplinks and infrastructure, then restart PoE or the interface.AOS6 and AOS8 orchestrated workflow with mandatory uplink safeguards
custom_runbookCustom RunbookAdvancedchangenoneRun an approved, reusable CLI workflow with variables, staged steps, target limits and audit logging.Depends on the commands authored in the runbook and the target switch AOS/model
reload_switchReload switchSystemchangenoneSafely reboot a standalone switch from its working software directory.AOS-family specific reload command
reload_stack_memberReload stack memberSystemchangeslotReboot only the selected physical stack member while the remaining members stay online.AOS8 chassis-id or AOS6 role-aware stack reload