Command Reference¶

All xcsh commands follow a consistent pattern:

xcsh <command-group> <action> [resource-type] [name] [flags]

Command Groups¶

xcsh organizes commands into logical groups:

Command	Description
admin_console_and_ui	Static UI components and console assets.
ai_services	AI assistant queries and feedback
api	Interface definitions, schema validation, and grouping.
authentication	Authentication API
bigip	iRules, data groups, and APM integration.
billing_and_usage	Subscription plans, payment methods, and quotas.
blindfold	Secret encryption, key policies, and audit trails.
bot_and_threat_defense	Bot detection, threat categories, and defense instances.
cdn	Edge caching, content delivery, and distribution rules.
ce_management	Network interfaces, fleets, and site registration.
certificates	SSL/TLS chains, trusted CAs, and revocation lists.
cloud_infrastructure	AWS, Azure, GCP connectors and VPC attachments.
cloudstatus	F5 XC service status and incidents
completion	Shell completion script generation
container_services	Containerized workloads and virtual Kubernetes clusters.
data_and_privacy_security	PII detection, data types, and regional compliance.
data_intelligence	Data Intelligence API
ddos	Volumetric attack mitigation and traffic scrubbing.
dns	Zones, record types, and load balancing.
login	Authentication and session management
managed_kubernetes	Cluster RBAC, pod security, and container registries.
marketplace	Add-on services, connectors, and TPM policies.
network	BGP peering, IPsec tunnels, and segment policies.
network_security	NAT policies, firewalls, and segment connections.
nginx_one	NGINX Plus instances and dataplane servers.
object_storage	Mobile SDK assets, versioned binaries, and app shield files.
observability	Synthetic health checks and DNS resolution validation.
rate_limiting	Request throttling, quotas, and policer rules.
secops_and_incident_response	Threat detection, user risk scoring, and automated blocking.
service_mesh	Microservice routing and sidecar configuration.
shape	Bot defense, fraud prevention, and client integrity.
sites	Cloud and edge node deployments.
statistics	Alerts, logs, flow analytics, and reporting.
subscription	Subscription and billing management
support	Tickets, escalations, and network diagnostics.
telemetry_and_insights	Telemetry And Insights API
tenant_and_identity	User profiles, sessions, and OTP settings.
threat_campaign	Threat Campaign API
users	Account tokens, labels, and cloud-init config.
virtual	HTTP, TCP, UDP load balancers and origin pools.
vpm_and_node_management	Vpm And Node Management API
waf	Request inspection, attack signatures, and bot mitigation.

Global Flags¶

These flags are available for all commands:

Flag	Short	Type	Default	Description
`----output`	`--o`	string	table	Output format
`----namespace`	`--ns`	string		Namespace to use for the operation
`----no-color`		boolean	false	Disable colored output
`----spec`		boolean		Output command specification as JSON (for AI assistants)
`----help`	`--h`	boolean		Show help information
`----version`	`--v`	boolean		Show version number

Quick Start¶

List resources¶

xcsh identity list namespace

Get a specific resource¶

xcsh identity get namespace example-namespace

Create from file¶

xcsh load_balancer create http_loadbalancer -i lb.yaml

Delete a resource¶

xcsh load_balancer delete http_loadbalancer example-lb -n example-namespace

Output Formats¶

xcsh supports multiple output formats:

Format	Flag	Description
Text	`--output-format text`	Human-readable text output (default)
JSON	`--output-format json`	JSON format for scripting
YAML	`--output-format yaml`	YAML format for configuration
Table	`--output-format table`	Tabular format for lists

Environment Variables¶

Variable	Description
`VES_API_TOKEN`	API token for authentication (use with `--api-token` flag)
`VES_P12_PASSWORD`	Password for P12 bundle file