rConfig V8 CLI Commands Reference - Complete Network Automation Guide
rConfig V8 CLI Commands Reference - Complete Network Automation Guide
Section titled “rConfig V8 CLI Commands Reference - Complete Network Automation Guide”rConfig V8 includes a comprehensive set of command-line interface (CLI) commands for managing your network configuration platform. In V8, a number of commands have been added, some have been changed, and others removed to streamline operations and align with modern workflows.
Why Use CLI Commands?
Section titled “Why Use CLI Commands?”CLI commands are essential for several key use cases:
- Automation & Orchestration: Integrate rConfig operations into Infrastructure as Code platforms like Ansible, Terraform, or Chef
- Custom Scripting: Build your own automation workflows and scheduled tasks that interact with rConfig
- System Administration: Perform maintenance tasks, clear caches, and troubleshoot issues directly from the command line
- CI/CD Pipelines: Incorporate network configuration management into your DevOps workflows
- Remote Management: Execute operations on rConfig without requiring access to the web interface
- Performance: Bypass UI overhead for bulk operations and scheduled tasks
Getting Started with CLI Commands
Section titled “Getting Started with CLI Commands”All rConfig CLI commands must be run from the rConfig installation directory and require root privileges.
Prerequisites
Section titled “Prerequisites”- SSH access to your rConfig server
- Root user privileges (or use
sudo) - Navigate to the rConfig installation directory:
cd /var/www/html/rconfig8/currentDiscovering Available Commands
Section titled “Discovering Available Commands”To view all available rConfig-specific commands:
php artisan rconfig:listThis command brings up a search box where you can type the partial name of the command you are looking for. Or hit enter to see the full list of commands.
Tip: Use the documentation search feature to quickly find detailed information about any command by searching for its name (e.g., “rconfig:download-device”).
rconfig:api-docs:build Generate AI-agent-friendly Markdown docs for the REST API under storage/app/api-docs. Uses Scribe as the upstream extractor. rconfig:append-compliance-report-data Append report result summary data to a saved compliance report rconfig:archive-logs Deprecated in 8.1 - Replaced with the Data Purge Tool in System Settings rconfig:backup-env Backup the .env file to the storage backups directory rconfig:cleanup-temp-snippets Clean up expired temporary snippets rconfig:clear-all Clear all cache and config elements for Laravel, NPM and other dependencies rconfig:clear-horizon Clear Horizon Queue History rconfig:config-encryption-manager Manage configuration encryption, including encrypting, decrypting, and rotating keys rconfig:config-history:audit Audit config history invariants (latest flags, config change versions) rconfig:config-history:repair Audit & repair config history invariants (versions, latest flags, consistency) rconfig:config-summaries-sync Sync Config Summaries rconfig:connectivity-check Check rConfig portal connectivity rconfig:data-purge Purge old data based on settings_purge configuration with hybrid queue support rconfig:digest-cleanup Cleanup old digest data via job queue rconfig:digest-send Send digest emails to users via job queue rconfig:download-api Download api configurations for one or multiple api connections via the CLI rconfig:download-category Download configurations for one or multiple categories of devices rconfig:download-device Download configurations for one or multiple devices via the CLI rconfig:download-tag Download configurations for devices with one or multiple tags rconfig:download-task Download configurations for devices with one or multiple tasks rconfig:ensure-device-admin-role Ensure every device has at least one role assignment that includes the System Admin role (ID:1) rconfig:integration-nautobot In Development: Command to sync Nautobot devices to rConfig via API integration. rconfig:integration-nautobot-single-device Process a single Nautobot device through ETL workflow, requires a Nautobot Device ID. rconfig:integration-netbox In Development: Command to sync Netbox devices to rConfig via API integration. rconfig:integration-netbox-single-device Process a single Netbox device through ETL workflow, requires a Netbox Device ID. rconfig:integration-v2-run Queue a V2 integration run for a specific integration instance. rconfig:integration-v2-sync-definitions Sync integration_definitions for V2 drivers from the registered source drivers and schema metadata rconfig:integration-zabbix In Development: Command to sync Zabbix devices to rConfig via API integration. rconfig:integration-zabbix-single-device Process a single Zabbix device through ETL workflow, requires a Zabbix Host ID. rconfig:list List all rconfig:* commands with their descriptions rconfig:netmri-connection Manage NetMRI API connection configuration rconfig:netmri-device-mappings Manage device type mappings for NetMRI import rconfig:netmri-import-devices Import devices from NetMRI JSON file to rConfig database rconfig:netmri-load-devices Load devices from NetMRI API to create rConfig import JSON rconfig:notify-on-config-change Notify about configuration changes that occurred today rconfig:oxidized-device-mappings Manage device type mappings for Oxidized import rconfig:oxidized-import-devices Import devices from JSON file to rConfig database rconfig:oxidized-load-devices Import devices from Oxidized to rConfig rconfig:policy-definition-validation A command to validate a given policy definition against a specific config rconfig:purge-configs Deprecated in 8.1 - Replaced with the Config Retention & History Repair Tool rconfig:purge-configs-v2 Deprecated in 8.1 - Replaced with the Config Retention & History Repair Tool rconfig:purge-failedconfigs Purge failed configs for some or all devices rconfig:rancid-device-mappings Manage device type mappings for RANCID import rconfig:rancid-import-devices Import devices from RANCID JSON file to rConfig database rconfig:rancid-load-devices Load devices from RANCID to create rConfig import JSON rconfig:report-lastDownload Output report of all devices latest downloaded configs rconfig:run-policy-compliance Send a policy assignment job to the queue rconfig:seed-initial Seed initial data after migrations rconfig:seed-purge-defaults Seed default purge settings for all tables rconfig:send-snippet Send a snippet to one or multiple devices via the CLI rconfig:slacktest Test Slack integration rconfig:snippet-task Send snippets to devices with one or multiple tasks rconfig:snmp-poll-device Poll SNMP data for a specific device or all devices with optional walk functionality rconfig:snmp-registry Manage SNMP trap registry from GitHub rconfig:snmp-trap-handler Handle incoming SNMP traps and process them rconfig:snmp-trap-supervisor Manage SNMP trap handler service via Supervisor rconfig:solarwinds-connection Manage SolarWinds SWIS API connection configuration rconfig:solarwinds-device-mappings Manage device type mappings for SolarWinds import rconfig:solarwinds-import-devices Import devices from SolarWinds JSON file to rConfig database rconfig:solarwinds-load-devices Load devices from SolarWinds SWIS API to create rConfig import JSON rconfig:sweep-xftp-dir Sweeps the xFTP directory for files, attempts to match filename to device ID and uploads them to the correct device directory rconfig:sync-tasks Sync the schedule of the app with the schedule monitor rconfig:test-notifications-recipients Test the getNotificationRecipients method with different notification types and channels rconfig:transform-eoc-definitions Transform legacy EOC definitions JSON to CIC policy format and update the database rconfig:transform-policy-definitions Transform policy definitions JSON and update the database rconfig:update-device-roles Update all devices to ensure they at least have admin have roles attached to them. rconfig:update-rbac-data Command to update or refresh permissions table with new permissions rconfig:update-snippet-roles Update all snippets to ensure they at least have admin have roles attached to them. rconfig:update-tag-roles Update all tags to ensure they at least have admin have roles attached to them. rconfig:vector-cm-accept-proposed Simulate Central Manager accepting the latest proposed device (local dev only) rconfig:vector-cm-messages Consume messages from rConfig Vector Central Manager RabbitMQ queue rconfig:vector:cm-outbox-list List sync_outbox rows with optional filters rconfig:vector:cm-outbox-republish Dispatch PublishOutboxRowJob for sync_outbox rows rconfig:xftp-backfill-uploads Backfill xFTP uploads tracking table from existing filesystem data (root xFTP dir and per-device xftpuploads dirs) rconfig:xftp-toggle Toggle FTP/ TFTP or SFTP(SCP) servers on or offAll above commands must be run from within the rconfig8 directory, and must be run in the following format.
Command Reference
Section titled “Command Reference”rconfig:api-docs:build
Section titled “rconfig:api-docs:build”Generates AI-agent-friendly Markdown documentation for the REST API under storage/app/api-docs. Uses Scribe as the upstream extractor.
# Build markdown docs for all API versions (default)php artisan rconfig:api-docs:build
# Build for a specific API version (v1, v2, or all)php artisan rconfig:api-docs:build --api-version=v2
# Skip Scribe regeneration and re-render markdown from existing openapi.yamlphp artisan rconfig:api-docs:build --no-generaterconfig:append-compliance-report-data
Section titled “rconfig:append-compliance-report-data”Appends report result summary data to a saved compliance report. Runs automatically for compliance jobs post V7.2.6, but can be run manually to update reports or fix missing data.
# Append data to specific reportphp artisan rconfig:append-compliance-report-data 123
# Append data to all reportsphp artisan rconfig:append-compliance-report-datarconfig:archive-logs
Section titled “rconfig:archive-logs”Deprecated in rConfig V8.1 and replaced with the Data Purge Tool in System Settings. The command remains as a stub for backward compatibility but should not be used. Use the Data Purge Tool to archive or delete old logs based on your retention policies.
rconfig:backup-env
Section titled “rconfig:backup-env”Backs up the .env file to the storage backups directory. Useful prior to upgrades or before making environment changes.
php artisan rconfig:backup-envrconfig:cleanup-temp-snippets
Section titled “rconfig:cleanup-temp-snippets”Removes expired temporary snippets from the system. This command is run automatically daily via the scheduler.
php artisan rconfig:cleanup-temp-snippetsrconfig:clear-all ⭐
Section titled “rconfig:clear-all ⭐”Clears all cache and config elements for Laravel, NPM, and other dependencies. Use this to resolve many application issues. This is an important command to run after updates or configuration changes.
php artisan rconfig:clear-allrconfig:clear-horizon
Section titled “rconfig:clear-horizon”Clears Horizon queue history and failed jobs.
php artisan rconfig:clear-horizonrconfig:config-encryption-manager
Section titled “rconfig:config-encryption-manager”Manages configuration file encryption, including encrypting, decrypting, and rotating encryption keys.
php artisan rconfig:config-encryption-managerrconfig:config-history:audit
Section titled “rconfig:config-history:audit”Audits configuration history invariants such as latest flags and config change versions to identify inconsistencies. See Config Retention & Repair for more details.
php artisan rconfig:config-history:auditrconfig:config-history:repair
Section titled “rconfig:config-history:repair”Audits and repairs configuration history invariants including versions, latest flags, and consistency. See Config Retention & Repair for more details.
php artisan rconfig:config-history:repairrconfig:config-summaries-sync
Section titled “rconfig:config-summaries-sync”Syncs configuration count summaries to the database for faster UI load times. Runs automatically daily at 3AM.
php artisan rconfig:config-summaries-syncrconfig:connectivity-check
Section titled “rconfig:connectivity-check”Tests rConfig portal connectivity.
php artisan rconfig:connectivity-checkrconfig:data-purge
Section titled “rconfig:data-purge”Purges old data based on settings_purge configuration with hybrid queue support.
php artisan rconfig:data-purgerconfig:digest-cleanup
Section titled “rconfig:digest-cleanup”Cleans up old email digest data via job queue. This command is run automatically daily via the scheduler.
php artisan rconfig:digest-cleanuprconfig:digest-send
Section titled “rconfig:digest-send”Sends digest emails to users via job queue.
php artisan rconfig:digest-sendrconfig:download-api
Section titled “rconfig:download-api”Downloads API configurations for one or multiple API connections.
# Download from specific API collectionsphp artisan rconfig:download-api 500000 500001
# Enable debug outputphp artisan rconfig:download-api 500000 -drconfig:download-category
Section titled “rconfig:download-category”Downloads configurations for all devices in specified categories (Command Groups).
# Download from one or more categoriesphp artisan rconfig:download-category 1 2rconfig:download-device ⭐
Section titled “rconfig:download-device ⭐”Downloads configurations for specified devices. This command is essential for on-demand config retrieval and debugging.
# Download from specific devicesphp artisan rconfig:download-device 1002 1003
# Enable debug outputphp artisan rconfig:download-device 1002 -d
# Search by integration host IDphp artisan rconfig:download-device 1002 -irconfig:download-tag
Section titled “rconfig:download-tag”Downloads configurations for all devices with specified tags.
php artisan rconfig:download-tag 1001rconfig:download-task
Section titled “rconfig:download-task”Downloads configurations for all devices associated with specified tasks.
php artisan rconfig:download-task 555555 666666rconfig:ensure-device-admin-role
Section titled “rconfig:ensure-device-admin-role”Ensures every device has at least one role assignment that includes the System Admin role (ID:1). Useful for repairing role assignments after bulk imports or upgrades.
php artisan rconfig:ensure-device-admin-rolerconfig:integration-nautobot
Section titled “rconfig:integration-nautobot”Syncs Nautobot devices to rConfig via API integration. See Nautobot Integration documentation for details.
php artisan rconfig:integration-nautobotrconfig:integration-nautobot-single-device
Section titled “rconfig:integration-nautobot-single-device”Processes a single Nautobot device through ETL workflow. Requires Nautobot Device ID.
php artisan rconfig:integration-nautobot-single-device {device-id}rconfig:integration-netbox
Section titled “rconfig:integration-netbox”Syncs Netbox devices to rConfig via API integration. See Netbox Integration documentation for details.
php artisan rconfig:integration-netboxrconfig:integration-netbox-single-device
Section titled “rconfig:integration-netbox-single-device”Processes a single Netbox device through ETL workflow. Requires Netbox Device ID.
php artisan rconfig:integration-netbox-single-device {device-id}rconfig:integration-v2-run
Section titled “rconfig:integration-v2-run”Queues a V2 integration run for a specific integration instance. Supports preview/apply modes and inline or queued execution.
# Preview run for instance ID 5 (default mode is preview)php artisan rconfig:integration-v2-run 5
# Apply run for instance ID 5php artisan rconfig:integration-v2-run 5 --mode=apply
# Run by driver key instead of instance IDphp artisan rconfig:integration-v2-run --driver=zabbix
# Dispatch asynchronously to the queuephp artisan rconfig:integration-v2-run 5 --queue
# Verbose debug outputphp artisan rconfig:integration-v2-run 5 -drconfig:integration-v2-sync-definitions
Section titled “rconfig:integration-v2-sync-definitions”Syncs integration_definitions for V2 drivers from the registered source drivers and schema metadata.
# Sync definitionsphp artisan rconfig:integration-v2-sync-definitions
# Also deactivate definitions no longer present in the source registryphp artisan rconfig:integration-v2-sync-definitions --cleanuprconfig:integration-zabbix
Section titled “rconfig:integration-zabbix”Syncs Zabbix devices to rConfig via API integration. See Zabbix Integration documentation for details.
php artisan rconfig:integration-zabbixrconfig:integration-zabbix-single-device
Section titled “rconfig:integration-zabbix-single-device”Processes a single Zabbix device through ETL workflow. Requires Zabbix Host ID.
php artisan rconfig:integration-zabbix-single-device {host-id}rconfig:list
Section titled “rconfig:list”Lists all rconfig:* commands with their descriptions.
php artisan rconfig:listrconfig:netmri-connection
Section titled “rconfig:netmri-connection”Manages the NetMRI API connection configuration used to import devices from Infoblox NetMRI.
# Set up NetMRI connection interactivelyphp artisan rconfig:netmri-connection --setup
# Test the existing connectionphp artisan rconfig:netmri-connection --test
# Show current connection infophp artisan rconfig:netmri-connection --show
# Edit device filtersphp artisan rconfig:netmri-connection --edit-filters
# Update the API URLphp artisan rconfig:netmri-connection --set-url=https://netmri.example.com
# Clear stored connection infophp artisan rconfig:netmri-connection --clearrconfig:netmri-device-mappings
Section titled “rconfig:netmri-device-mappings”Manages device type mappings used when importing from NetMRI.
# List all current mappingsphp artisan rconfig:netmri-device-mappings --list
# Add a new mapping interactivelyphp artisan rconfig:netmri-device-mappings --add
# Edit a mapping by NetMRI device typephp artisan rconfig:netmri-device-mappings --edit="Cisco IOS"
# Delete a mapping by NetMRI device typephp artisan rconfig:netmri-device-mappings --delete="Cisco IOS"rconfig:netmri-import-devices
Section titled “rconfig:netmri-import-devices”Imports devices from a NetMRI JSON file into the rConfig database.
# Import devices from a JSON filephp artisan rconfig:netmri-import-devices /path/to/netmri-export.json
# Assign imported devices to a specific device groupphp artisan rconfig:netmri-import-devices /path/to/netmri-export.json --group=2
# Validate without writing to the databasephp artisan rconfig:netmri-import-devices /path/to/netmri-export.json --dry-runrconfig:netmri-load-devices
Section titled “rconfig:netmri-load-devices”Loads devices from the NetMRI API and creates a JSON file for use with rconfig:netmri-import-devices.
# Load devices using default batch sizephp artisan rconfig:netmri-load-devices
# Override the batch sizephp artisan rconfig:netmri-load-devices --batch-size=200
# Cap the number of devices fetched (useful for testing)php artisan rconfig:netmri-load-devices --max-devices=50rconfig:notify-on-config-change
Section titled “rconfig:notify-on-config-change”Sends notifications about configuration changes that occurred today. Typically driven by the scheduler.
php artisan rconfig:notify-on-config-changerconfig:oxidized-device-mappings
Section titled “rconfig:oxidized-device-mappings”Manages device type mappings for Oxidized import.
php artisan rconfig:oxidized-device-mappingsrconfig:oxidized-import-devices
Section titled “rconfig:oxidized-import-devices”Imports devices from JSON file to rConfig database.
php artisan rconfig:oxidized-import-devicesrconfig:oxidized-load-devices
Section titled “rconfig:oxidized-load-devices”Imports devices from Oxidized to rConfig.
php artisan rconfig:oxidized-load-devicesrconfig:policy-definition-validation
Section titled “rconfig:policy-definition-validation”Validates a given policy definition against a specific configuration.
php artisan rconfig:policy-definition-validationrconfig:purge-configs
Section titled “rconfig:purge-configs”Deprecated in rConfig V8.1 and replaced with the Config Retention & History Repair Tool. The command remains as a stub for backward compatibility but should not be used. Use the Config Retention & History Repair Tool in System Settings to manage configuration retention policies and repair configuration history.
rconfig:purge-configs-v2
Section titled “rconfig:purge-configs-v2”Deprecated in rConfig V8.1 and replaced with the Config Retention & History Repair Tool. The command remains as a stub for backward compatibility but should not be used. Use the Config Retention & History Repair Tool in System Settings to manage configuration retention policies and repair configuration history.
rconfig:purge-failedconfigs
Section titled “rconfig:purge-failedconfigs”Purges failed configurations for specified or all devices.
# Purge failed configs for specific devicesphp artisan rconfig:purge-failedconfigs 1001 1002
# Purge all failed configsphp artisan rconfig:purge-failedconfigs --allrconfig:rancid-device-mappings
Section titled “rconfig:rancid-device-mappings”Manages device type mappings used when importing from RANCID.
# List all current mappingsphp artisan rconfig:rancid-device-mappings --list
# Add a new mapping interactivelyphp artisan rconfig:rancid-device-mappings --add
# Edit a mapping by RANCID device typephp artisan rconfig:rancid-device-mappings --edit=cisco
# Delete a mapping by RANCID device typephp artisan rconfig:rancid-device-mappings --delete=ciscorconfig:rancid-import-devices
Section titled “rconfig:rancid-import-devices”Imports devices from a RANCID JSON file into the rConfig database.
# Import devices from a JSON filephp artisan rconfig:rancid-import-devices /path/to/rancid-export.json
# Assign imported devices to a specific device groupphp artisan rconfig:rancid-import-devices /path/to/rancid-export.json --group=2
# Validate without writing to the databasephp artisan rconfig:rancid-import-devices /path/to/rancid-export.json --dry-runrconfig:rancid-load-devices
Section titled “rconfig:rancid-load-devices”Loads devices from a RANCID installation and creates a JSON file for use with rconfig:rancid-import-devices.
# Load using auto-detected RANCID base pathphp artisan rconfig:rancid-load-devices
# Specify a custom RANCID base pathphp artisan rconfig:rancid-load-devices --rancid-base=/usr/local/rancid
# Import only a specific RANCID groupphp artisan rconfig:rancid-load-devices --group=networkingrconfig:report-lastDownload
Section titled “rconfig:report-lastDownload”Generates CLI report of all devices’ latest downloaded configurations.
php artisan rconfig:report-lastDownloadrconfig:run-policy-compliance
Section titled “rconfig:run-policy-compliance”Sends a policy assignment job to the queue for compliance checking.
# Run compliance for specific policy assignmentphp artisan rconfig:run-policy-compliance 1rconfig:seed-initial
Section titled “rconfig:seed-initial”Seeds initial data after migrations. Typically used during installation. Do not run on production systems unless directed by support.
php artisan rconfig:seed-initialrconfig:seed-purge-defaults
Section titled “rconfig:seed-purge-defaults”Seeds default purge settings for all tables. Use this to reset purge settings to defaults. This command is run automatically during setup and updates in V8 installations.
php artisan rconfig:seed-purge-defaultsrconfig:send-snippet
Section titled “rconfig:send-snippet”Sends a command snippet to specified devices.
# Send snippet ID 5 to devices 21 and 22php artisan rconfig:send-snippet 5 21 22rconfig:slacktest
Section titled “rconfig:slacktest”Tests Slack integration configuration. Sends a test message to the configured Slack channel.
php artisan rconfig:slacktestrconfig:snippet-task
Section titled “rconfig:snippet-task”Sends snippets to all devices associated with specified tasks.
# Send snippets for task 123456php artisan rconfig:snippet-task 123456
# Enable debug outputphp artisan rconfig:snippet-task 123456 -drconfig:snmp-poll-device
Section titled “rconfig:snmp-poll-device”Polls SNMP data for specific device or all devices with optional walk functionality.
php artisan rconfig:snmp-poll-devicerconfig:snmp-registry
Section titled “rconfig:snmp-registry”Manages SNMP trap registry from GitHub.
php artisan rconfig:snmp-registryrconfig:snmp-trap-handler
Section titled “rconfig:snmp-trap-handler”Handles incoming SNMP traps and processes them.
php artisan rconfig:snmp-trap-handlerrconfig:snmp-trap-supervisor
Section titled “rconfig:snmp-trap-supervisor”Manages SNMP trap handler service via Supervisor.
php artisan rconfig:snmp-trap-supervisorrconfig:solarwinds-connection
Section titled “rconfig:solarwinds-connection”Manages the SolarWinds SWIS API connection configuration used to import nodes from SolarWinds NPM.
# Set up the SWIS connection interactivelyphp artisan rconfig:solarwinds-connection --setup
# Test the existing connectionphp artisan rconfig:solarwinds-connection --test
# Show current connection infophp artisan rconfig:solarwinds-connection --show
# Edit node filtersphp artisan rconfig:solarwinds-connection --edit-filters
# Update the SWIS URLphp artisan rconfig:solarwinds-connection --set-url=https://solarwinds.example.com:17778
# Clear stored connection infophp artisan rconfig:solarwinds-connection --clearrconfig:solarwinds-device-mappings
Section titled “rconfig:solarwinds-device-mappings”Manages device type mappings used when importing from SolarWinds.
# List all current mappingsphp artisan rconfig:solarwinds-device-mappings --list
# Add a new mapping interactivelyphp artisan rconfig:solarwinds-device-mappings --add
# Edit a mapping by SolarWinds machine typephp artisan rconfig:solarwinds-device-mappings --edit="Cisco IOS"
# Delete a mapping by SolarWinds machine typephp artisan rconfig:solarwinds-device-mappings --delete="Cisco IOS"rconfig:solarwinds-import-devices
Section titled “rconfig:solarwinds-import-devices”Imports devices from a SolarWinds JSON file into the rConfig database.
# Import devices from a JSON filephp artisan rconfig:solarwinds-import-devices /path/to/solarwinds-export.json
# Assign imported devices to a specific device groupphp artisan rconfig:solarwinds-import-devices /path/to/solarwinds-export.json --group=2
# Validate without writing to the databasephp artisan rconfig:solarwinds-import-devices /path/to/solarwinds-export.json --dry-runrconfig:solarwinds-load-devices
Section titled “rconfig:solarwinds-load-devices”Loads nodes from the SolarWinds SWIS API and creates a JSON file for use with rconfig:solarwinds-import-devices.
# Load nodes using default batch sizephp artisan rconfig:solarwinds-load-devices
# Override the batch sizephp artisan rconfig:solarwinds-load-devices --batch-size=200
# Cap the number of nodes fetched (useful for testing)php artisan rconfig:solarwinds-load-devices --max-nodes=50rconfig:sweep-xftp-dir
Section titled “rconfig:sweep-xftp-dir”Sweeps the xFTP directory for files, matches filenames to device IDs, and uploads them to the correct device directory.
php artisan rconfig:sweep-xftp-dirrconfig:sync-tasks
Section titled “rconfig:sync-tasks”Syncs the application schedule with the schedule monitor.
php artisan rconfig:sync-tasksrconfig:test-notifications-recipients
Section titled “rconfig:test-notifications-recipients”Tests the notification recipients method with different notification types and channels.
php artisan rconfig:test-notifications-recipientsrconfig:transform-eoc-definitions
Section titled “rconfig:transform-eoc-definitions”Transforms legacy EOC definitions JSON to CIC policy format and updates the database.
php artisan rconfig:transform-eoc-definitionsrconfig:transform-policy-definitions
Section titled “rconfig:transform-policy-definitions”Transforms policy definitions JSON and updates the database.
php artisan rconfig:transform-policy-definitionsrconfig:update-device-roles
Section titled “rconfig:update-device-roles”Updates all devices to ensure they have at least admin roles attached.
php artisan rconfig:update-device-rolesrconfig:update-rbac-data ⭐
Section titled “rconfig:update-rbac-data ⭐”Updates or refreshes permissions table with new permissions. Essential command if you have added new roles or permissions via updates or you get 403 errors in the UI.
php artisan rconfig:update-rbac-datarconfig:update-snippet-roles
Section titled “rconfig:update-snippet-roles”Updates all snippets to ensure they have at least admin roles attached.
php artisan rconfig:update-snippet-rolesrconfig:update-tag-roles
Section titled “rconfig:update-tag-roles”Updates all tags to ensure they have at least admin roles attached.
php artisan rconfig:update-tag-rolesrconfig:vector-cm-accept-proposed
Section titled “rconfig:vector-cm-accept-proposed”Simulates the Central Manager accepting the latest proposed device. Intended for local development only.
# Accept the latest proposed devicephp artisan rconfig:vector-cm-accept-proposed
# Accept a specific event IDphp artisan rconfig:vector-cm-accept-proposed --event-id=abc123rconfig:vector-cm-messages
Section titled “rconfig:vector-cm-messages”Consumes messages from rConfig Vector Central Manager RabbitMQ queue.
php artisan rconfig:vector-cm-messagesrconfig:vector:cm-outbox-list
Section titled “rconfig:vector:cm-outbox-list”Lists sync_outbox rows with optional filters. Useful for inspecting what the Central Manager outbox has produced.
# List the most recent 10 rows (default)php artisan rconfig:vector:cm-outbox-list
# Filter by statusphp artisan rconfig:vector:cm-outbox-list --status=pending
# Filter by event type and aggregatephp artisan rconfig:vector:cm-outbox-list --event-type=device.updated --aggregate-type=device --aggregate-id=1002
# Show only rows accepted (or not) by Central Managerphp artisan rconfig:vector:cm-outbox-list --accepted=yes --limit=50rconfig:vector:cm-outbox-republish
Section titled “rconfig:vector:cm-outbox-republish”Dispatches PublishOutboxRowJob for sync_outbox rows. Useful for replaying or recovering Central Manager events.
# Republish a specific outbox row by IDphp artisan rconfig:vector:cm-outbox-republish --id=42
# Republish rows by status (default limit 100)php artisan rconfig:vector:cm-outbox-republish --status=failed --limit=25
# Override the queue namephp artisan rconfig:vector:cm-outbox-republish --status=pending --queue=rConfigDefault
# Force-publish, ignoring CM guard, timing, and acceptance checksphp artisan rconfig:vector:cm-outbox-republish --id=42 --forcerconfig:xftp-backfill-uploads
Section titled “rconfig:xftp-backfill-uploads”Backfills the xFTP uploads tracking table from existing filesystem data (root xFTP directory and per-device xftpuploads directories).
# Backfill all filesphp artisan rconfig:xftp-backfill-uploads
# Dry run (no DB writes)php artisan rconfig:xftp-backfill-uploads --dry-run
# Cap the number of files scannedphp artisan rconfig:xftp-backfill-uploads --limit=1000rconfig:xftp-toggle
Section titled “rconfig:xftp-toggle”Toggles FTP/TFTP or SFTP(SCP) servers on or off.
# Toggle FTP/TFTP onphp artisan rconfig:xftp-toggle on
# Toggle FTP/TFTP offphp artisan rconfig:xftp-toggle offAdditional Notes
Section titled “Additional Notes”- All commands must be run from the rConfig installation directory (
/var/www/html/rconfig8/current) - Commands require root privileges or sudo access
- Many commands support the
-dflag for verbose debug output - For detailed integration documentation, refer to the specific integration sections in the documentation
Related Documentation
Section titled “Related Documentation”- Config Retention & Repair - Retention policies and automated config repair