Skip to content

Latest commit

 

History

History
150 lines (147 loc) · 14.2 KB

File metadata and controls

150 lines (147 loc) · 14.2 KB

Megaport CLI Documentation

Generated on July 8, 2026 for version v1.0.0-beta.1

Available Commands

Command Description
megaport-cli A CLI tool to interact with the Megaport API
megaport-cli apply Provision multiple resources from a config file
megaport-cli auth Manage authentication and view current identity
megaport-cli auth status Display current authentication status and identity
megaport-cli billing-market Manage billing markets for the Megaport API
megaport-cli billing-market get Get billing market configurations
megaport-cli billing-market set Set billing market configuration
megaport-cli completion Generate completion script
megaport-cli config Manage configuration settings
megaport-cli config clear-defaults Clear all default settings
megaport-cli config create-profile Create a new credential profile
megaport-cli config delete-profile Delete a profile
megaport-cli config export Export configuration
megaport-cli config get-default Get a default value
megaport-cli config import Import configuration
megaport-cli config list-profiles List all profiles
megaport-cli config remove-default Remove a default value
megaport-cli config set-default Set a default value
megaport-cli config update-profile Update an existing profile
megaport-cli config use-profile Switch to a profile
megaport-cli config view Display current configuration
megaport-cli generate-docs Generate documentation for the CLI
megaport-cli ix Manage Internet Exchanges (IXs) in the Megaport API
megaport-cli ix buy Buy an IX through the Megaport API
megaport-cli ix delete Delete an IX from your account
megaport-cli ix get Get details for a single IX
megaport-cli ix list List all IXs with optional filters
megaport-cli ix status Check the provisioning status of an IX
megaport-cli ix update Update an existing IX
megaport-cli ix validate Validate an IX order without purchasing
megaport-cli locations Manage locations in the Megaport API
megaport-cli locations get Get details for a specific location by ID
megaport-cli locations list List all locations
megaport-cli locations list-countries List all countries with Megaport locations
megaport-cli locations list-market-codes List all market codes
megaport-cli locations rtt Query round-trip times between locations
megaport-cli locations search Search locations by name (fuzzy match)
megaport-cli managed-account Manage partner managed accounts in the Megaport API
megaport-cli managed-account create Create a new managed account
megaport-cli managed-account get Get details for a single managed account
megaport-cli managed-account list List all managed accounts
megaport-cli managed-account update Update an existing managed account
megaport-cli mcr Manage MCRs in the Megaport API
megaport-cli mcr add-ipsec-addon Add an IPSec add-on to an existing MCR
megaport-cli mcr buy Buy an MCR through the Megaport API
megaport-cli mcr create-prefix-filter-list Create a prefix filter list on an MCR
megaport-cli mcr delete Delete an MCR from your account
megaport-cli mcr delete-prefix-filter-list Delete a prefix filter list on an MCR
megaport-cli mcr get Get details for a single MCR
megaport-cli mcr get-prefix-filter-list Get details for a single prefix filter list on an MCR
megaport-cli mcr list List all MCRs with optional filters
megaport-cli mcr list-prefix-filter-lists List all prefix filter lists for a specific MCR
megaport-cli mcr list-tags List resource tags on a specific MCR
megaport-cli mcr lock Lock an MCR
megaport-cli mcr looking-glass MCR Looking Glass diagnostic commands
megaport-cli mcr looking-glass bgp-neighbor-routes List routes advertised to or received from a BGP neighbor
megaport-cli mcr looking-glass bgp-routes List BGP routes with full BGP attributes
megaport-cli mcr looking-glass bgp-sessions List BGP sessions configured on the MCR
megaport-cli mcr looking-glass ip-routes List IP routes from the MCR routing table
megaport-cli mcr looking-glass ping Run a ping from the MCR to a destination
megaport-cli mcr looking-glass traceroute Run a traceroute from the MCR to a destination
megaport-cli mcr restore Restore a deleted MCR
megaport-cli mcr status Check the provisioning status of an MCR
megaport-cli mcr unlock Unlock an MCR
megaport-cli mcr update Update an existing MCR
megaport-cli mcr update-ipsec-addon Update or disable an IPSec add-on on an MCR
megaport-cli mcr update-prefix-filter-list Update a prefix filter list on an MCR
megaport-cli mcr update-tags Update resource tags on a specific MCR
megaport-cli mcr validate Validate an MCR order without purchasing
megaport-cli mve Manage Megaport Virtual Edge (MVE) devices
megaport-cli mve buy Purchase a new Megaport Virtual Edge (MVE) device
megaport-cli mve delete Delete an existing MVE
megaport-cli mve get Get details for a single MVE
megaport-cli mve list List all MVEs with optional filters
megaport-cli mve list-images List all available MVE images
megaport-cli mve list-sizes List all available MVE sizes
megaport-cli mve list-tags List resource tags on a specific MVE
megaport-cli mve lock Lock an MVE
megaport-cli mve status Check the provisioning status of an MVE
megaport-cli mve unlock Unlock an MVE
megaport-cli mve update Update an existing MVE
megaport-cli mve update-tags Update resource tags on a specific MVE
megaport-cli mve validate Validate an MVE order without purchasing
megaport-cli nat-gateway Manage NAT Gateways in the Megaport API
megaport-cli nat-gateway buy Purchase a NAT Gateway design to begin provisioning
megaport-cli nat-gateway create Create a new NAT Gateway
megaport-cli nat-gateway delete Delete a NAT Gateway
megaport-cli nat-gateway get Get details for a single NAT Gateway
megaport-cli nat-gateway list List all NAT Gateways
megaport-cli nat-gateway list-sessions List available NAT Gateway speed/session-count combinations
megaport-cli nat-gateway telemetry Get telemetry data for a NAT Gateway
megaport-cli nat-gateway update Update an existing NAT Gateway
megaport-cli nat-gateway validate Validate a NAT Gateway design without purchasing
megaport-cli partners Manage partner ports in the Megaport API
megaport-cli partners find Find partner ports interactively
megaport-cli partners list List all partner ports
megaport-cli ports Manage ports in the Megaport API
megaport-cli ports buy Buy a port through the Megaport API
megaport-cli ports buy-lag Buy a LAG port through the Megaport API
megaport-cli ports check-vlan Check if a VLAN is available on a port
megaport-cli ports delete Delete a port from your account
megaport-cli ports get Get details for a single port
megaport-cli ports list List all ports with optional filters
megaport-cli ports list-tags List resource tags on a specific port.
megaport-cli ports lock Lock a port
megaport-cli ports restore Restore a deleted port
megaport-cli ports status Check the provisioning status of a port
megaport-cli ports unlock Unlock a port
megaport-cli ports update Update a port's details
megaport-cli ports update-tags Update resource tags on a specific port
megaport-cli ports validate Validate a port order without purchasing
megaport-cli ports validate-lag Validate a LAG port order without purchasing
megaport-cli product Manage products in the Megaport API
megaport-cli product get-type Get the type of a product by UID
megaport-cli product list List all products with optional filters
megaport-cli servicekeys Manage service keys for the Megaport API
megaport-cli servicekeys create Create a new service key
megaport-cli servicekeys get Get details of a service key
megaport-cli servicekeys list List all service keys
megaport-cli servicekeys update Update an existing service key
megaport-cli status Show a dashboard of all Megaport resources
megaport-cli topology Show resource relationship tree
megaport-cli users Manage users in the Megaport API
megaport-cli users activity View user activity logs
megaport-cli users create Create a new user
megaport-cli users deactivate Deactivate a user
megaport-cli users delete Delete a user
megaport-cli users get Get details for a specific user
megaport-cli users list List all company users
megaport-cli users update Update an existing user
megaport-cli version Print the version number of Megaport CLI
megaport-cli vxc Manage VXCs in the Megaport API
megaport-cli vxc buy Purchase a new VXC
megaport-cli vxc delete Delete an existing Virtual Cross Connect (VXC)
megaport-cli vxc get Get details for a single VXC
megaport-cli vxc list List all VXCs with optional filters
megaport-cli vxc list-tags List resource tags on a specific VXC
megaport-cli vxc status Check the provisioning status of a VXC
megaport-cli vxc update Update an existing Virtual Cross Connect (VXC)
megaport-cli vxc update-tags Update resource tags on a specific VXC
megaport-cli vxc validate Validate a VXC order without purchasing
megaport-cli whoami Display current authenticated identity