agilicus 1.299.2__py3-none-any.whl → 1.299.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
README-cli.md DELETED
@@ -1,2107 +0,0 @@
1
- # Agilicus CLI Command Reference
2
-
3
- This document provides a comprehensive reference for all CLI commands available in the Agilicus CLI tool, organized by functional categories.
4
-
5
- ## Table of Contents
6
-
7
- - [Users](#users)
8
- - [Resources](#resources)
9
- - [Identity](#identity)
10
- - [Billing](#billing)
11
- - [Operations](#operations)
12
- - [Policy](#policy)
13
- - [Miscellaneous](#miscellaneous)
14
-
15
- ---
16
-
17
- ## Users
18
-
19
- Commands for managing users, groups, service accounts, permissions, SSH access, desktops, shares, and launchers.
20
-
21
- ### User Management
22
-
23
- #### `list-users`
24
- **Usage:** `agilicus list-users [OPTIONS]`
25
-
26
- Lists users in the system with various filtering options.
27
-
28
- **Arguments:**
29
- - `--organisation` - Filter by organisation name
30
- - `--org-id` - Filter by organisation ID
31
- - `--email` - Filter by email address
32
- - `--previous-email` - Filter by previous email
33
- - `--limit` - Maximum number of results (default: None)
34
- - `--status` - Filter by user status (multiple values allowed)
35
- - `--search-direction` - Search direction (forwards/backwards)
36
- - `--has-roles` - Filter users with roles (boolean)
37
- - `--has-resource-roles` - Filter users with resource roles (boolean)
38
- - `--prefix-email-search` - Email prefix search
39
- - `--first-name` - Filter by first name
40
- - `--last-name` - Filter by last name
41
- - `--user-id` - Filter by user ID
42
- - `--search-param` - Additional search parameters (multiple)
43
- - `--allow-partial-match` - Allow partial matching
44
- - `--type` - User type filter (multiple)
45
- - `--upstream-idp-id` - Upstream IDP ID
46
- - `--upstream-user-id` - Upstream user ID
47
- - `--issuer` - Issuer filter
48
- - `--has-application-permissions` - Filter by application permissions
49
- - `--show-columns` - Specify columns to show
50
- - `--reset-columns` - Reset column display
51
- - `--has-resource-or-application-roles` - Filter by resource or application roles
52
-
53
- #### `show-user`
54
- **Usage:** `agilicus show-user EMAIL_OR_ID [OPTIONS]`
55
-
56
- Shows detailed information about a specific user.
57
-
58
- **Arguments:**
59
- - `EMAIL_OR_ID` - User email address or ID
60
- - `--org-id` - Organisation ID
61
-
62
- #### `add-user`
63
- **Usage:** `agilicus add-user FIRST_NAME LAST_NAME EMAIL ORG_ID [OPTIONS]`
64
-
65
- Creates a new user in the system.
66
-
67
- **Arguments:**
68
- - `FIRST_NAME` - User's first name
69
- - `LAST_NAME` - User's last name
70
- - `EMAIL` - User's email address
71
- - `ORG_ID` - Organisation ID
72
- - `--external-id` - External identifier
73
- - `--enabled` - Enable/disable user (boolean)
74
- - `--status` - User status
75
- - `--description` - User description
76
-
77
- #### `update-user`
78
- **Usage:** `agilicus update-user EMAIL_OR_ID [OPTIONS]`
79
-
80
- Updates an existing user's information.
81
-
82
- **Arguments:**
83
- - `EMAIL_OR_ID` - User email address or ID
84
- - `--email` - New email address
85
- - `--org-id` - Organisation ID
86
- - `--first-name` - New first name
87
- - `--last-name` - New last name
88
- - `--external-id` - External identifier
89
- - `--auto-created` - Auto-created flag (boolean)
90
- - `--enabled` - Enable/disable user (boolean)
91
- - `--cascade` - Cascade changes (boolean)
92
- - `--status` - User status
93
- - `--description` - User description
94
- - `--attribute` - User attributes (key-value pairs, multiple)
95
- - `--remove-attribute` - Attributes to remove (multiple)
96
- - `--disabled-at-time` - Disable timestamp
97
-
98
- #### `delete-user`
99
- **Usage:** `agilicus delete-user EMAIL [OPTIONS]`
100
-
101
- Deletes a user from the system.
102
-
103
- **Arguments:**
104
- - `EMAIL` - User email address
105
- - `--org-id` - Organisation ID
106
-
107
- ### User Roles and Permissions
108
-
109
- #### `add-user-role`
110
- **Usage:** `agilicus add-user-role EMAIL_OR_ID APPLICATION [OPTIONS]`
111
-
112
- Adds roles to a user for a specific application.
113
-
114
- **Arguments:**
115
- - `EMAIL_OR_ID` - User email address or ID
116
- - `APPLICATION` - Application name
117
- - `--role` - Role names to add (multiple)
118
- - `--org-id` - Organisation ID
119
- - `--update` - Update existing roles
120
-
121
- #### `list-user-roles`
122
- **Usage:** `agilicus list-user-roles EMAIL [OPTIONS]`
123
-
124
- Lists all roles assigned to a user.
125
-
126
- **Arguments:**
127
- - `EMAIL` - User email address
128
- - `--org-id` - Organisation ID
129
-
130
- #### `list-elevated-permissions`
131
- **Usage:** `agilicus list-elevated-permissions [OPTIONS]`
132
-
133
- Lists elevated permissions for users.
134
-
135
- **Arguments:**
136
- - `--user-id` - User ID (defaults to current user)
137
- - `--limit` - Maximum number of results
138
-
139
- #### `show-elevated-permissions`
140
- **Usage:** `agilicus show-elevated-permissions USER_ID`
141
-
142
- Shows elevated permissions for a specific user.
143
-
144
- **Arguments:**
145
- - `USER_ID` - User ID
146
-
147
- #### `add-elevated-permissions`
148
- **Usage:** `agilicus add-elevated-permissions USER_ID APPLICATION NAME`
149
-
150
- Adds elevated permissions to a user.
151
-
152
- **Arguments:**
153
- - `USER_ID` - User ID
154
- - `APPLICATION` - Application name
155
- - `NAME` - Permission name
156
-
157
- #### `delete-elevated-permissions`
158
- **Usage:** `agilicus delete-elevated-permissions USER_ID APPLICATION NAME`
159
-
160
- Removes elevated permissions from a user.
161
-
162
- **Arguments:**
163
- - `USER_ID` - User ID
164
- - `APPLICATION` - Application name
165
- - `NAME` - Permission name
166
-
167
- #### `clear-elevated-permissions`
168
- **Usage:** `agilicus clear-elevated-permissions USER_ID`
169
-
170
- Clears all elevated permissions for a user.
171
-
172
- **Arguments:**
173
- - `USER_ID` - User ID
174
-
175
- ### Groups
176
-
177
- #### `list-groups`
178
- **Usage:** `agilicus list-groups [OPTIONS]`
179
-
180
- Lists groups in the system.
181
-
182
- **Arguments:**
183
- - `--organisation` - Organisation name
184
- - `--org-id` - Organisation ID
185
- - `--type` - Group type (default: group)
186
- - `--limit` - Maximum results (default: 500)
187
- - `--previous-email` - Previous email filter
188
- - `--prefix-email-search` - Email prefix search
189
- - `--hide-members` - Hide group members (boolean)
190
- - `--search-direction` - Search direction
191
- - `--first-name` - First name filter
192
- - `--last-name` - Last name filter
193
- - `--search-param` - Search parameters (multiple)
194
- - `--allow-partial-match` - Allow partial matching
195
-
196
- #### `list-sysgroups`
197
- **Usage:** `agilicus list-sysgroups [OPTIONS]`
198
-
199
- Lists system groups.
200
-
201
- **Arguments:**
202
- - `--organisation` - Organisation name
203
- - `--org-id` - Organisation ID
204
- - `--hide-members` - Hide group members (boolean)
205
-
206
- #### `add-group`
207
- **Usage:** `agilicus add-group FIRST_NAME [OPTIONS]`
208
-
209
- Creates a new group.
210
-
211
- **Arguments:**
212
- - `FIRST_NAME` - Group name
213
- - `--org-id` - Organisation ID
214
- - `--type` - Group type (default: group)
215
- - `--cascade` - Cascade creation
216
-
217
- #### `show-group`
218
- **Usage:** `agilicus show-group GROUP_ID [OPTIONS]`
219
-
220
- Shows detailed information about a group.
221
-
222
- **Arguments:**
223
- - `GROUP_ID` - Group ID
224
- - `--org-id` - Organisation ID
225
-
226
- #### `add-group-member`
227
- **Usage:** `agilicus add-group-member GROUP_ID [OPTIONS]`
228
-
229
- Adds members to a group.
230
-
231
- **Arguments:**
232
- - `GROUP_ID` - Group ID
233
- - `--org-id` - Organisation ID
234
- - `--member-org-id` - Member organisation ID
235
- - `--member` - Member IDs (multiple)
236
- - `--email` - Member emails (multiple)
237
-
238
- #### `delete-group-member`
239
- **Usage:** `agilicus delete-group-member GROUP_ID [OPTIONS]`
240
-
241
- Removes members from a group.
242
-
243
- **Arguments:**
244
- - `GROUP_ID` - Group ID
245
- - `--member` - Member IDs to remove (multiple)
246
- - `--org-id` - Organisation ID
247
-
248
- #### `delete-group`
249
- **Usage:** `agilicus delete-group GROUP_ID`
250
-
251
- Deletes a group.
252
-
253
- **Arguments:**
254
- - `GROUP_ID` - Group ID
255
-
256
- ### Service Accounts
257
-
258
- #### `list-service-accounts`
259
- **Usage:** `agilicus list-service-accounts [OPTIONS]`
260
-
261
- Lists service accounts.
262
-
263
- **Arguments:**
264
- - `--org-id` - Organisation ID
265
- - `--user-id` - User ID
266
- - `--limit` - Maximum results (default: 500)
267
-
268
- #### `add-service-account`
269
- **Usage:** `agilicus add-service-account ORG_ID NAME [OPTIONS]`
270
-
271
- Creates a new service account.
272
-
273
- **Arguments:**
274
- - `ORG_ID` - Organisation ID
275
- - `NAME` - Service account name
276
- - `--enabled/--disabled` - Enable/disable account
277
- - `--allowed_sub_org` - Allowed sub-organisations (multiple)
278
- - `--description` - Account description
279
-
280
- #### `show-service-account`
281
- **Usage:** `agilicus show-service-account SERVICE_ACCOUNT_ID [OPTIONS]`
282
-
283
- Shows service account details.
284
-
285
- **Arguments:**
286
- - `SERVICE_ACCOUNT_ID` - Service account ID
287
- - `--org-id` - Organisation ID
288
-
289
- #### `delete-service-account`
290
- **Usage:** `agilicus delete-service-account SERVICE_ACCOUNT_ID [OPTIONS]`
291
-
292
- Deletes a service account.
293
-
294
- **Arguments:**
295
- - `SERVICE_ACCOUNT_ID` - Service account ID
296
- - `--org-id` - Organisation ID
297
-
298
- #### `update-service-account`
299
- **Usage:** `agilicus update-service-account SERVICE_ACCOUNT_ID [OPTIONS]`
300
-
301
- Updates a service account.
302
-
303
- **Arguments:**
304
- - `SERVICE_ACCOUNT_ID` - Service account ID
305
- - `--name` - New name
306
- - `--enabled/--disabled` - Enable/disable account
307
- - `--allowed_sub_org` - Allowed sub-organisations (multiple)
308
- - `--description` - Account description
309
- - `--org-id` - Organisation ID
310
-
311
- ### User Access Information
312
-
313
- #### `list-user-application-access-info`
314
- **Usage:** `agilicus list-user-application-access-info [OPTIONS]`
315
-
316
- Lists user's application access information.
317
-
318
- **Arguments:**
319
- - `--user` - User email or ID
320
- - `--org-id` - Organisation ID
321
- - `--resource-id` - Resource ID
322
- - `--limit` - Maximum results (default: 500)
323
-
324
- #### `list-user-fileshare-access-info`
325
- **Usage:** `agilicus list-user-fileshare-access-info [OPTIONS]`
326
-
327
- Lists user's file share access information.
328
-
329
- **Arguments:**
330
- - `--user` - User email or ID
331
- - `--org-id` - Organisation ID
332
- - `--resource-id` - Resource ID
333
- - `--limit` - Maximum results (default: 500)
334
-
335
- #### `list-user-desktop-access-info`
336
- **Usage:** `agilicus list-user-desktop-access-info [OPTIONS]`
337
-
338
- Lists user's desktop access information.
339
-
340
- **Arguments:**
341
- - `--user` - User email or ID
342
- - `--org-id` - Organisation ID
343
- - `--desktop-type` - Desktop type
344
- - `--resource-id` - Resource ID
345
- - `--limit` - Maximum results (default: 500)
346
-
347
- #### `list-user-resource-access-info`
348
- **Usage:** `agilicus list-user-resource-access-info [OPTIONS]`
349
-
350
- Lists user's resource access information.
351
-
352
- **Arguments:**
353
- - `--user` - User email or ID
354
- - `--org-id` - Organisation ID
355
- - `--resource-id` - Resource ID
356
- - `--include_all_resource_type` - Include all resource types (default: True)
357
- - `--resource-type` - Resource type filter
358
- - `--limit` - Maximum results (default: 500)
359
-
360
- #### `list-user-ssh-access-info`
361
- **Usage:** `agilicus list-user-ssh-access-info [OPTIONS]`
362
-
363
- Lists user's SSH access information.
364
-
365
- **Arguments:**
366
- - `--user` - User email or ID
367
- - `--org-id` - Organisation ID
368
- - `--resource-id` - Resource ID
369
- - `--limit` - Maximum results (default: 500)
370
-
371
- #### `list-user-launcher-access-info`
372
- **Usage:** `agilicus list-user-launcher-access-info [OPTIONS]`
373
-
374
- Lists user's launcher access information.
375
-
376
- **Arguments:**
377
- - `--user` - User email or ID
378
- - `--org-id` - Organisation ID
379
- - `--resource-id` - Resource ID
380
- - `--limit` - Maximum results (default: 500)
381
-
382
- ### User Requests
383
-
384
- #### `list-user-requests`
385
- **Usage:** `agilicus list-user-requests [OPTIONS]`
386
-
387
- Lists user access requests.
388
-
389
- **Arguments:**
390
- - `--user-id` - User ID
391
- - `--org-id` - Organisation ID
392
- - `--request-type` - Request type
393
- - `--request-state` - Request state
394
- - `--limit` - Maximum results (default: 500)
395
- - `--expired` - Filter expired requests (boolean)
396
-
397
- #### `add-user-request`
398
- **Usage:** `agilicus add-user-request USER_ID ORG_ID REQUESTED_RESOURCE REQUESTED_RESOURCE_TYPE [OPTIONS]`
399
-
400
- Creates a new user access request.
401
-
402
- **Arguments:**
403
- - `USER_ID` - User ID
404
- - `ORG_ID` - Organisation ID
405
- - `REQUESTED_RESOURCE` - Requested resource
406
- - `REQUESTED_RESOURCE_TYPE` - Resource type
407
- - `--request-information` - Request information
408
- - `--requested-sub-resource` - Sub-resource
409
- - `--expiry-date` - Expiry date
410
- - `--from-date` - From date
411
- - `--to-date` - To date
412
-
413
- #### `update-user-request`
414
- **Usage:** `agilicus update-user-request USER_REQUEST_ID [OPTIONS]`
415
-
416
- Updates a user access request.
417
-
418
- **Arguments:**
419
- - `USER_REQUEST_ID` - Request ID
420
- - `--org-id` - Organisation ID
421
- - `--user-id` - User ID
422
- - `--requested-resource` - Requested resource
423
- - `--requested-sub-resource` - Sub-resource
424
- - `--requested-resource-type` - Resource type
425
- - `--request-information` - Request information
426
- - `--response-information` - Response information
427
-
428
- #### `action-user-request`
429
- **Usage:** `agilicus action-user-request USER_REQUEST_ID STATE [OPTIONS]`
430
-
431
- Takes action on a user access request.
432
-
433
- **Arguments:**
434
- - `USER_REQUEST_ID` - Request ID
435
- - `STATE` - Action state (approved/declined)
436
- - `--org-id` - Organisation ID
437
- - `--requested-resource` - Requested resource
438
- - `--requested-resource-type` - Resource type
439
- - `--request-information` - Request information
440
-
441
- #### `bulk-action-user-request`
442
- **Usage:** `agilicus bulk-action-user-request [OPTIONS]`
443
-
444
- Takes bulk action on user requests.
445
-
446
- **Arguments:**
447
- - `--user-id` - User ID (required)
448
- - `--org-id` - Organisation ID
449
- - `--state` - Action state (approved/declined)
450
- - `--user-status` - User status
451
- - `--reset-user` - Reset user (boolean)
452
-
453
- #### `show-user-request`
454
- **Usage:** `agilicus show-user-request USER_REQUEST_ID [OPTIONS]`
455
-
456
- Shows details of a user request.
457
-
458
- **Arguments:**
459
- - `USER_REQUEST_ID` - Request ID
460
- - `--user-id` - User ID
461
- - `--org-id` - Organisation ID
462
-
463
- #### `delete-user-request`
464
- **Usage:** `agilicus delete-user-request USER_REQUEST_ID [OPTIONS]`
465
-
466
- Deletes a user request.
467
-
468
- **Arguments:**
469
- - `USER_REQUEST_ID` - Request ID
470
- - `--user-id` - User ID
471
- - `--org-id` - Organisation ID
472
-
473
- #### `list-access-requests`
474
- **Usage:** `agilicus list-access-requests [OPTIONS]`
475
-
476
- Lists access requests.
477
-
478
- **Arguments:**
479
- - `--org-id` - Organisation ID
480
- - `--user-id` - User ID
481
- - `--request-type` - Request type
482
- - `--request-state` - Request state
483
- - `--limit` - Maximum results (default: 500)
484
- - `--email` - Email filter
485
- - `--search-direction` - Search direction
486
-
487
- ### User Metadata
488
-
489
- #### `list-user-metadata`
490
- **Usage:** `agilicus list-user-metadata [OPTIONS]`
491
-
492
- Lists user metadata.
493
-
494
- **Arguments:**
495
- - `--user-id` - User ID
496
- - `--org-id` - Organisation ID
497
- - `--data-type` - Data type
498
- - `--app-id` - Application ID
499
- - `--recursive` - Recursive search (boolean)
500
- - `--limit` - Maximum results (default: 500)
501
-
502
- #### `add-user-metadata`
503
- **Usage:** `agilicus add-user-metadata USER_ID ORG_ID DATA_TYPE DATA [OPTIONS]`
504
-
505
- Adds metadata to a user.
506
-
507
- **Arguments:**
508
- - `USER_ID` - User ID
509
- - `ORG_ID` - Organisation ID
510
- - `DATA_TYPE` - Data type (mfa_enrollment_expiry, user_app_data, user_org_data, json)
511
- - `DATA` - Metadata data
512
- - `--app-id` - Application ID
513
- - `--name` - Metadata name
514
-
515
- #### `update-user-metadata`
516
- **Usage:** `agilicus update-user-metadata USER_METADATA_ID [OPTIONS]`
517
-
518
- Updates user metadata.
519
-
520
- **Arguments:**
521
- - `USER_METADATA_ID` - Metadata ID
522
- - `--org-id` - Organisation ID
523
- - `--user-id` - User ID
524
- - `--data_type` - Data type
525
- - `--data` - Metadata data
526
- - `--app-id` - Application ID
527
- - `--name` - Metadata name
528
-
529
- #### `show-user-metadata`
530
- **Usage:** `agilicus show-user-metadata USER_METADATA_ID [OPTIONS]`
531
-
532
- Shows user metadata details.
533
-
534
- **Arguments:**
535
- - `USER_METADATA_ID` - Metadata ID
536
- - `--user-id` - User ID
537
- - `--org-id` - Organisation ID
538
-
539
- #### `delete-user-metadata`
540
- **Usage:** `agilicus delete-user-metadata USER_METADATA_ID [OPTIONS]`
541
-
542
- Deletes user metadata.
543
-
544
- **Arguments:**
545
- - `USER_METADATA_ID` - Metadata ID
546
- - `--user-id` - User ID
547
- - `--org-id` - Organisation ID
548
-
549
- #### `bulk-set-metadata`
550
- **Usage:** `agilicus bulk-set-metadata ORG_ID DATA_TYPE DATA [OPTIONS]`
551
-
552
- Sets metadata for multiple users.
553
-
554
- **Arguments:**
555
- - `ORG_ID` - Organisation ID
556
- - `DATA_TYPE` - Data type
557
- - `DATA` - Metadata data
558
- - `--app-id` - Application ID
559
- - `--name` - Metadata name
560
-
561
- ---
562
-
563
- ## Resources
564
-
565
- Commands for managing applications, networks, resources, environments, labels, icons, and related configurations.
566
-
567
- ### Applications
568
-
569
- #### `list-applications`
570
- **Usage:** `agilicus list-applications [OPTIONS]`
571
-
572
- Lists applications in the system.
573
-
574
- **Arguments:**
575
- - `--organisation` - Organisation name
576
- - `--org-id` - Organisation ID
577
- - `--resource-id` - Resource ID
578
- - `--updated_since` - Updated since timestamp
579
- - `--maintained/--no-maintained` - Filter by maintenance status
580
- - `--owned/--no-owned` - Filter by ownership
581
- - `--assigned/--no-assigned` - Filter by assignment
582
- - `--include-migrated-environments/--exclude-migrated-environments` - Include migrated environments
583
-
584
- #### `show-application`
585
- **Usage:** `agilicus show-application APP [OPTIONS]`
586
-
587
- Shows detailed information about an application.
588
-
589
- **Arguments:**
590
- - `APP` - Application name
591
- - `--org-id` - Organisation ID
592
- - `--include-migrated-environments` - Include migrated environments (default: True)
593
-
594
- #### `add-application`
595
- **Usage:** `agilicus add-application NAME ORG_ID CATEGORY [OPTIONS]`
596
-
597
- Creates a new application.
598
-
599
- **Arguments:**
600
- - `NAME` - Application name
601
- - `ORG_ID` - Organisation ID
602
- - `CATEGORY` - Application category
603
- - `--published` - Publication status (no/public)
604
- - `--default-role-id` - Default role ID
605
- - `--icon-url` - Icon URL
606
- - `--location` - Location (hosted/external)
607
- - `--service-account-required` - Require service account
608
- - `--name-slug` - Name slug
609
-
610
- #### `update-application`
611
- **Usage:** `agilicus update-application APP [OPTIONS]`
612
-
613
- Updates an existing application.
614
-
615
- **Arguments:**
616
- - `APP` - Application name
617
- - `--image` - Application image
618
- - `--port` - Application port
619
- - `--org-id` - Organisation ID
620
- - `--published` - Publication status (no/public)
621
- - `--default-role-id` - Default role ID
622
- - `--icon-url` - Icon URL
623
- - `--location` - Location (hosted/external)
624
- - `--service-account-id` - Service account ID
625
- - `--service-account-required/--no-service-account-required` - Service account requirement
626
- - `--name-slug` - Name slug
627
- - `--admin-state` - Admin state (active/disabled)
628
- - `--description` - Application description
629
-
630
- #### `delete-application`
631
- **Usage:** `agilicus delete-application APP [OPTIONS]`
632
-
633
- Deletes an application.
634
-
635
- **Arguments:**
636
- - `APP` - Application name
637
- - `--org-id` - Organisation ID
638
-
639
- #### `assign-application`
640
- **Usage:** `agilicus assign-application ENV_NAME APP_ID ORG_ID ASSIGNED_ORG_ID [OPTIONS]`
641
-
642
- Assigns an application to an organisation.
643
-
644
- **Arguments:**
645
- - `ENV_NAME` - Environment name
646
- - `APP_ID` - Application ID
647
- - `ORG_ID` - Organisation ID
648
- - `ASSIGNED_ORG_ID` - Assigned organisation ID
649
- - `--admin-org-id` - Admin organisation ID
650
-
651
- #### `unassign-application`
652
- **Usage:** `agilicus unassign-application ENV_NAME APP_ID ORG_ID ASSIGNED_ORG_ID`
653
-
654
- Unassigns an application from an organisation.
655
-
656
- **Arguments:**
657
- - `ENV_NAME` - Environment name
658
- - `APP_ID` - Application ID
659
- - `ORG_ID` - Organisation ID
660
- - `ASSIGNED_ORG_ID` - Assigned organisation ID
661
-
662
- ### Application Services
663
-
664
- #### `list-application-services`
665
- **Usage:** `agilicus list-application-services [OPTIONS]`
666
-
667
- Lists application services.
668
-
669
- **Arguments:**
670
- - `--org-id` - Organisation ID
671
- - `--updated-since` - Updated since timestamp
672
- - `--protocol-type` - Protocol type (ip/fileshare/ssh)
673
- - `--protocol-type-list` - Protocol types (multiple)
674
- - `--hostname` - Hostname filter
675
- - `--port` - Port filter
676
- - `--name` - Name filter
677
- - `--hostname_or_service_name` - Hostname or service name
678
- - `--external_hostname_or_service` - External hostname or service
679
- - `--show-status` - Show status information
680
-
681
- #### `add-application-service`
682
- **Usage:** `agilicus add-application-service NAME HOSTNAME PORT [OPTIONS]`
683
-
684
- Creates a new application service.
685
-
686
- **Arguments:**
687
- - `NAME` - Service name
688
- - `HOSTNAME` - Service hostname
689
- - `PORT` - Service port
690
- - `--org-id` - Organisation ID
691
- - `--ipv4-addresses` - IPv4 addresses
692
- - `--name-resolution` - Name resolution
693
- - `--protocol` - Protocol
694
- - `--tls-enabled/--tls-disabled` - TLS configuration
695
- - `--tls-verify/--tls-no-verify` - TLS verification
696
- - `--connector-id` - Connector ID
697
- - `--connector-instance-id` - Connector instance ID
698
- - `--learning-mode` - Learning mode (boolean)
699
- - `--learning-mode-expiry` - Learning mode expiry
700
- - `--diagnostic-mode` - Diagnostic mode (boolean)
701
-
702
- #### `update-application-service`
703
- **Usage:** `agilicus update-application-service ID [OPTIONS]`
704
-
705
- Updates an application service.
706
-
707
- **Arguments:**
708
- - `ID` - Service ID
709
- - `--name` - Service name
710
- - `--hostname` - Service hostname
711
- - `--port` - Service port
712
- - `--org-id` - Organisation ID
713
- - `--ipv4-addresses` - IPv4 addresses
714
- - `--name-resolution` - Name resolution
715
- - `--service-type` - Service type (vpn/agent/internet/ipsec)
716
- - `--protocol` - Protocol
717
- - `--connector-id` - Connector ID
718
- - `--connector-instance-id` - Connector instance ID
719
- - `--tls-enabled/--tls-disabled` - TLS configuration
720
- - `--tls-verify/--tls-no-verify` - TLS verification
721
- - `--disable-http2` - Disable HTTP/2 (boolean)
722
- - `--expose-as-hostname` - Expose as hostname (boolean)
723
- - `--learning-mode` - Learning mode (boolean)
724
- - `--learning-mode-expiry` - Learning mode expiry
725
- - `--diagnostic-mode` - Diagnostic mode (boolean)
726
- - `--port-range` - Port range (comma-separated)
727
- - `--source-port-override` - Source port override
728
- - `--source-address-override` - Source address override
729
- - `--dynamic-source-port-override` - Dynamic source port override (boolean)
730
-
731
- #### `show-application-service`
732
- **Usage:** `agilicus show-application-service ID [OPTIONS]`
733
-
734
- Shows application service details.
735
-
736
- **Arguments:**
737
- - `ID` - Service ID
738
- - `--org-id` - Organisation ID
739
-
740
- #### `delete-application-service`
741
- **Usage:** `agilicus delete-application-service NAME [OPTIONS]`
742
-
743
- Deletes an application service.
744
-
745
- **Arguments:**
746
- - `NAME` - Service name
747
- - `--org-id` - Organisation ID
748
-
749
- #### `create-application-service-token`
750
- **Usage:** `agilicus create-application-service-token ID [OPTIONS]`
751
-
752
- Creates a token for an application service.
753
-
754
- **Arguments:**
755
- - `ID` - Service ID
756
- - `--org_id` - Organisation ID
757
-
758
- ### Application Service Assignments
759
-
760
- #### `add-application-service-assignment`
761
- **Usage:** `agilicus add-application-service-assignment APP_SERVICE_NAME APP ENVIRONMENT_NAME [OPTIONS]`
762
-
763
- Assigns an application service to an environment.
764
-
765
- **Arguments:**
766
- - `APP_SERVICE_NAME` - Application service name
767
- - `APP` - Application name
768
- - `ENVIRONMENT_NAME` - Environment name
769
- - `--org-id` - Organisation ID
770
- - `--expose-type` - Exposure type (not_exposed/application/path_prefix/hostname)
771
- - `--expose-as-hostname` - Expose as hostname
772
- - `--connection-mapping` - Connection mapping
773
-
774
- #### `update-application-service-assignment`
775
- **Usage:** `agilicus update-application-service-assignment APP_SERVICE_NAME APP ENVIRONMENT_NAME [OPTIONS]`
776
-
777
- Updates an application service assignment.
778
-
779
- **Arguments:**
780
- - `APP_SERVICE_NAME` - Application service name
781
- - `APP` - Application name
782
- - `ENVIRONMENT_NAME` - Environment name
783
- - `--org-id` - Organisation ID
784
- - `--expose-type` - Exposure type
785
- - `--expose-as-hostname` - Expose as hostname
786
- - `--expose-as-hostname-list-json` - Hostname list (JSON)
787
- - `--connection-mapping` - Connection mapping
788
-
789
- #### `delete-application-service-assignment`
790
- **Usage:** `agilicus delete-application-service-assignment APP_SERVICE_NAME APP ENVIRONMENT_NAME [OPTIONS]`
791
-
792
- Deletes an application service assignment.
793
-
794
- **Arguments:**
795
- - `APP_SERVICE_NAME` - Application service name
796
- - `APP` - Application name
797
- - `ENVIRONMENT_NAME` - Environment name
798
- - `--org-id` - Organisation ID
799
-
800
- ### Environments
801
-
802
- #### `list-environments`
803
- **Usage:** `agilicus list-environments APPLICATION [OPTIONS]`
804
-
805
- Lists environments for an application.
806
-
807
- **Arguments:**
808
- - `APPLICATION` - Application name
809
- - `--organisation` - Organisation name
810
- - `--org-id` - Organisation ID
811
- - `--filter` - Filter fields
812
-
813
- #### `show-environment`
814
- **Usage:** `agilicus show-environment APPLICATION ENV_NAME [OPTIONS]`
815
-
816
- Shows environment details.
817
-
818
- **Arguments:**
819
- - `APPLICATION` - Application name
820
- - `ENV_NAME` - Environment name
821
- - `--org-id` - Organisation ID
822
-
823
- #### `update-environment`
824
- **Usage:** `agilicus update-environment APP ENV_NAME [OPTIONS]`
825
-
826
- Updates an environment configuration.
827
-
828
- **Arguments:**
829
- - `APP` - Application name
830
- - `ENV_NAME` - Environment name
831
- - `--org-id` - Organisation ID
832
- - `--version-tag` - Version tag
833
- - `--serverless-image` - Serverless image
834
- - `--config-mount-path` - Config mount path
835
- - `--config-as-mount` - Config as mount (JSON)
836
- - `--config-as-env` - Config as environment (JSON)
837
- - `--secrets-mount-path` - Secrets mount path
838
- - `--secrets-as-mount` - Secrets as mount
839
- - `--secrets-as-env` - Secrets as environment
840
- - `--domain-aliases` - Domain aliases (multiple)
841
- - `--clear-aliases` - Clear aliases
842
- - `--name-slug` - Name slug
843
- - `--proxy-location` - Proxy location (in_cloud/on_site)
844
- - `--application-configs-data` - Application configs (JSON string)
845
- - `--application-configs-file` - Application configs (JSON file)
846
-
847
- #### `delete-environment`
848
- **Usage:** `agilicus delete-environment APP ENV_NAME [OPTIONS]`
849
-
850
- Deletes an environment.
851
-
852
- **Arguments:**
853
- - `APP` - Application name
854
- - `ENV_NAME` - Environment name
855
- - `--org-id` - Organisation ID
856
-
857
- #### `set-env-runtime-status`
858
- **Usage:** `agilicus set-env-runtime-status APP ENV_NAME [OPTIONS]`
859
-
860
- Sets environment runtime status.
861
-
862
- **Arguments:**
863
- - `APP` - Application name
864
- - `ENV_NAME` - Environment name
865
- - `--org-id` - Organisation ID
866
- - `--overall-status` - Overall status
867
- - `--running-replicas` - Running replicas
868
- - `--error-message` - Error message
869
- - `--restarts` - Restarts (JSON)
870
- - `--cpu` - CPU usage (JSON)
871
- - `--memory` - Memory usage
872
- - `--running-image` - Running image
873
- - `--running-hash` - Running hash
874
-
875
- #### `get-env-status`
876
- **Usage:** `agilicus get-env-status APP ENV_NAME [OPTIONS]`
877
-
878
- Gets environment status.
879
-
880
- **Arguments:**
881
- - `APP` - Application name
882
- - `ENV_NAME` - Environment name
883
- - `--org-id` - Organisation ID
884
- - `--organisation` - Organisation name
885
-
886
- ### Application Configuration
887
-
888
- #### `list-config`
889
- **Usage:** `agilicus list-config APPLICATION ENV_NAME [OPTIONS]`
890
-
891
- Lists application configuration.
892
-
893
- **Arguments:**
894
- - `APPLICATION` - Application name
895
- - `ENV_NAME` - Environment name
896
- - `--org-id` - Organisation ID
897
-
898
- #### `add-config`
899
- **Usage:** `agilicus add-config APPLICATION ENV_NAME [OPTIONS]`
900
-
901
- Adds application configuration.
902
-
903
- **Arguments:**
904
- - `APPLICATION` - Application name
905
- - `ENV_NAME` - Environment name
906
- - `--org-id` - Organisation ID
907
- - `--filename` - Configuration filename
908
- - `--config_type` - Configuration type (required)
909
- - `--mount-path` - Mount path (required)
910
- - `--mount-src-path` - Mount source path
911
- - `--username` - Username
912
- - `--hostname` - Hostname
913
- - `--password` - Password
914
- - `--share` - Share name
915
- - `--domain` - Domain
916
- - `--file-store-uri` - File store URI
917
-
918
- #### `update-config`
919
- **Usage:** `agilicus update-config APPLICATION ENV_NAME ID [OPTIONS]`
920
-
921
- Updates application configuration.
922
-
923
- **Arguments:**
924
- - `APPLICATION` - Application name
925
- - `ENV_NAME` - Environment name
926
- - `ID` - Configuration ID
927
- - `--org-id` - Organisation ID
928
- - `--config_type` - Configuration type
929
- - `--mount-path` - Mount path
930
- - `--mount-src-path` - Mount source path
931
- - `--username` - Username
932
- - `--password` - Password
933
- - `--share` - Share name
934
- - `--domain` - Domain
935
- - `--file-store-uri` - File store URI
936
-
937
- #### `delete-config`
938
- **Usage:** `agilicus delete-config APPLICATION ENV_NAME ID [OPTIONS]`
939
-
940
- Deletes application configuration.
941
-
942
- **Arguments:**
943
- - `APPLICATION` - Application name
944
- - `ENV_NAME` - Environment name
945
- - `ID` - Configuration ID
946
- - `--org-id` - Organisation ID
947
-
948
- ### Environment Variables
949
-
950
- #### `list-env-vars`
951
- **Usage:** `agilicus list-env-vars APPLICATION ENV_NAME [OPTIONS]`
952
-
953
- Lists environment variables.
954
-
955
- **Arguments:**
956
- - `APPLICATION` - Application name
957
- - `ENV_NAME` - Environment name
958
- - `--org-id` - Organisation ID
959
- - `--secret` - Include secrets (default: True)
960
-
961
- #### `add-env-var`
962
- **
963
- Usage:** `agilicus add-env-var APPLICATION ENV_NAME NAME VALUE [OPTIONS]`
964
-
965
- Adds an environment variable.
966
-
967
- **Arguments:**
968
- - `APPLICATION` - Application name
969
- - `ENV_NAME` - Environment name
970
- - `NAME` - Variable name
971
- - `VALUE` - Variable value
972
- - `--org-id` - Organisation ID
973
- - `--secret` - Mark as secret (boolean)
974
-
975
- #### `update-env-var`
976
- **Usage:** `agilicus update-env-var APPLICATION ENV_NAME NAME VALUE [OPTIONS]`
977
-
978
- Updates an environment variable.
979
-
980
- **Arguments:**
981
- - `APPLICATION` - Application name
982
- - `ENV_NAME` - Environment name
983
- - `NAME` - Variable name
984
- - `VALUE` - New variable value
985
- - `--org-id` - Organisation ID
986
- - `--secret` - Mark as secret (boolean)
987
-
988
- #### `delete-env-var`
989
- **Usage:** `agilicus delete-env-var APPLICATION ENV_NAME NAME [OPTIONS]`
990
-
991
- Deletes an environment variable.
992
-
993
- **Arguments:**
994
- - `APPLICATION` - Application name
995
- - `ENV_NAME` - Environment name
996
- - `NAME` - Variable name
997
- - `--org-id` - Organisation ID
998
-
999
- ### Networks
1000
-
1001
- #### `list-networks`
1002
- **Usage:** `agilicus list-networks [OPTIONS]`
1003
-
1004
- Lists networks in the system.
1005
-
1006
- **Arguments:**
1007
- - `--org-id` - Organisation ID
1008
- - `--limit` - Maximum results (default: 500)
1009
-
1010
- #### `add-network`
1011
- **Usage:** `agilicus add-network NAME CIDR [OPTIONS]`
1012
-
1013
- Creates a new network.
1014
-
1015
- **Arguments:**
1016
- - `NAME` - Network name
1017
- - `CIDR` - Network CIDR
1018
- - `--org-id` - Organisation ID
1019
- - `--description` - Network description
1020
-
1021
- #### `show-network`
1022
- **Usage:** `agilicus show-network NETWORK_ID [OPTIONS]`
1023
-
1024
- Shows network details.
1025
-
1026
- **Arguments:**
1027
- - `NETWORK_ID` - Network ID
1028
- - `--org-id` - Organisation ID
1029
-
1030
- #### `update-network`
1031
- **Usage:** `agilicus update-network NETWORK_ID [OPTIONS]`
1032
-
1033
- Updates a network.
1034
-
1035
- **Arguments:**
1036
- - `NETWORK_ID` - Network ID
1037
- - `--name` - Network name
1038
- - `--cidr` - Network CIDR
1039
- - `--org-id` - Organisation ID
1040
- - `--description` - Network description
1041
-
1042
- #### `delete-network`
1043
- **Usage:** `agilicus delete-network NETWORK_ID [OPTIONS]`
1044
-
1045
- Deletes a network.
1046
-
1047
- **Arguments:**
1048
- - `NETWORK_ID` - Network ID
1049
- - `--org-id` - Organisation ID
1050
-
1051
- ### Resources
1052
-
1053
- #### `list-resources`
1054
- **Usage:** `agilicus list-resources [OPTIONS]`
1055
-
1056
- Lists resources in the system.
1057
-
1058
- **Arguments:**
1059
- - `--org-id` - Organisation ID
1060
- - `--resource-type` - Resource type filter
1061
- - `--limit` - Maximum results (default: 500)
1062
-
1063
- #### `show-resource`
1064
- **Usage:** `agilicus show-resource RESOURCE_ID [OPTIONS]`
1065
-
1066
- Shows resource details.
1067
-
1068
- **Arguments:**
1069
- - `RESOURCE_ID` - Resource ID
1070
- - `--org-id` - Organisation ID
1071
-
1072
- ### Labels
1073
-
1074
- #### `list-labels`
1075
- **Usage:** `agilicus list-labels [OPTIONS]`
1076
-
1077
- Lists labels in the system.
1078
-
1079
- **Arguments:**
1080
- - `--org-id` - Organisation ID
1081
- - `--resource-type` - Resource type filter
1082
- - `--limit` - Maximum results (default: 500)
1083
-
1084
- #### `add-label`
1085
- **Usage:** `agilicus add-label NAME [OPTIONS]`
1086
-
1087
- Creates a new label.
1088
-
1089
- **Arguments:**
1090
- - `NAME` - Label name
1091
- - `--org-id` - Organisation ID
1092
- - `--description` - Label description
1093
- - `--color` - Label color
1094
-
1095
- #### `update-label`
1096
- **Usage:** `agilicus update-label LABEL_ID [OPTIONS]`
1097
-
1098
- Updates a label.
1099
-
1100
- **Arguments:**
1101
- - `LABEL_ID` - Label ID
1102
- - `--name` - Label name
1103
- - `--org-id` - Organisation ID
1104
- - `--description` - Label description
1105
- - `--color` - Label color
1106
-
1107
- #### `delete-label`
1108
- **Usage:** `agilicus delete-label LABEL_ID [OPTIONS]`
1109
-
1110
- Deletes a label.
1111
-
1112
- **Arguments:**
1113
- - `LABEL_ID` - Label ID
1114
- - `--org-id` - Organisation ID
1115
-
1116
- ### Icons
1117
-
1118
- #### `list-icons`
1119
- **Usage:** `agilicus list-icons [OPTIONS]`
1120
-
1121
- Lists icons in the system.
1122
-
1123
- **Arguments:**
1124
- - `--org-id` - Organisation ID
1125
- - `--limit` - Maximum results (default: 500)
1126
-
1127
- #### `add-icon`
1128
- **Usage:** `agilicus add-icon NAME URL [OPTIONS]`
1129
-
1130
- Creates a new icon.
1131
-
1132
- **Arguments:**
1133
- - `NAME` - Icon name
1134
- - `URL` - Icon URL
1135
- - `--org-id` - Organisation ID
1136
- - `--description` - Icon description
1137
-
1138
- #### `update-icon`
1139
- **Usage:** `agilicus update-icon ICON_ID [OPTIONS]`
1140
-
1141
- Updates an icon.
1142
-
1143
- **Arguments:**
1144
- - `ICON_ID` - Icon ID
1145
- - `--name` - Icon name
1146
- - `--url` - Icon URL
1147
- - `--org-id` - Organisation ID
1148
- - `--description` - Icon description
1149
-
1150
- #### `delete-icon`
1151
- **Usage:** `agilicus delete-icon ICON_ID [OPTIONS]`
1152
-
1153
- Deletes an icon.
1154
-
1155
- **Arguments:**
1156
- - `ICON_ID` - Icon ID
1157
- - `--org-id` - Organisation ID
1158
-
1159
- ---
1160
-
1161
- ## Identity
1162
-
1163
- Commands for managing identity providers, issuers, upstream providers, OIDC configurations, and authentication policies.
1164
-
1165
- ### Issuers
1166
-
1167
- #### `list-issuers`
1168
- **Usage:** `agilicus list-issuers [OPTIONS]`
1169
-
1170
- Lists identity issuers.
1171
-
1172
- **Arguments:**
1173
- - `--org-id` - Organisation ID
1174
- - `--limit` - Maximum results (default: 500)
1175
-
1176
- #### `add-issuer`
1177
- **Usage:** `agilicus add-issuer NAME ISSUER_URL [OPTIONS]`
1178
-
1179
- Creates a new identity issuer.
1180
-
1181
- **Arguments:**
1182
- - `NAME` - Issuer name
1183
- - `ISSUER_URL` - Issuer URL
1184
- - `--org-id` - Organisation ID
1185
- - `--description` - Issuer description
1186
- - `--enabled` - Enable issuer (boolean)
1187
-
1188
- #### `show-issuer`
1189
- **Usage:** `agilicus show-issuer ISSUER_ID [OPTIONS]`
1190
-
1191
- Shows issuer details.
1192
-
1193
- **Arguments:**
1194
- - `ISSUER_ID` - Issuer ID
1195
- - `--org-id` - Organisation ID
1196
-
1197
- #### `update-issuer`
1198
- **Usage:** `agilicus update-issuer ISSUER_ID [OPTIONS]`
1199
-
1200
- Updates an issuer.
1201
-
1202
- **Arguments:**
1203
- - `ISSUER_ID` - Issuer ID
1204
- - `--name` - Issuer name
1205
- - `--issuer-url` - Issuer URL
1206
- - `--org-id` - Organisation ID
1207
- - `--description` - Issuer description
1208
- - `--enabled` - Enable issuer (boolean)
1209
-
1210
- #### `delete-issuer`
1211
- **Usage:** `agilicus delete-issuer ISSUER_ID [OPTIONS]`
1212
-
1213
- Deletes an issuer.
1214
-
1215
- **Arguments:**
1216
- - `ISSUER_ID` - Issuer ID
1217
- - `--org-id` - Organisation ID
1218
-
1219
- ### Upstream Providers
1220
-
1221
- #### `list-upstream-providers`
1222
- **Usage:** `agilicus list-upstream-providers [OPTIONS]`
1223
-
1224
- Lists upstream identity providers.
1225
-
1226
- **Arguments:**
1227
- - `--org-id` - Organisation ID
1228
- - `--provider-type` - Provider type filter
1229
- - `--limit` - Maximum results (default: 500)
1230
-
1231
- #### `add-upstream-provider`
1232
- **Usage:** `agilicus add-upstream-provider NAME PROVIDER_TYPE [OPTIONS]`
1233
-
1234
- Creates a new upstream provider.
1235
-
1236
- **Arguments:**
1237
- - `NAME` - Provider name
1238
- - `PROVIDER_TYPE` - Provider type (oidc/saml/ldap)
1239
- - `--org-id` - Organisation ID
1240
- - `--description` - Provider description
1241
- - `--enabled` - Enable provider (boolean)
1242
- - `--config` - Provider configuration (JSON)
1243
-
1244
- #### `show-upstream-provider`
1245
- **Usage:** `agilicus show-upstream-provider PROVIDER_ID [OPTIONS]`
1246
-
1247
- Shows upstream provider details.
1248
-
1249
- **Arguments:**
1250
- - `PROVIDER_ID` - Provider ID
1251
- - `--org-id` - Organisation ID
1252
-
1253
- #### `update-upstream-provider`
1254
- **Usage:** `agilicus update-upstream-provider PROVIDER_ID [OPTIONS]`
1255
-
1256
- Updates an upstream provider.
1257
-
1258
- **Arguments:**
1259
- - `PROVIDER_ID` - Provider ID
1260
- - `--name` - Provider name
1261
- - `--provider-type` - Provider type
1262
- - `--org-id` - Organisation ID
1263
- - `--description` - Provider description
1264
- - `--enabled` - Enable provider (boolean)
1265
- - `--config` - Provider configuration (JSON)
1266
-
1267
- #### `delete-upstream-provider`
1268
- **Usage:** `agilicus delete-upstream-provider PROVIDER_ID [OPTIONS]`
1269
-
1270
- Deletes an upstream provider.
1271
-
1272
- **Arguments:**
1273
- - `PROVIDER_ID` - Provider ID
1274
- - `--org-id` - Organisation ID
1275
-
1276
- ### OIDC Configuration
1277
-
1278
- #### `list-oidc-configs`
1279
- **Usage:** `agilicus list-oidc-configs [OPTIONS]`
1280
-
1281
- Lists OIDC configurations.
1282
-
1283
- **Arguments:**
1284
- - `--org-id` - Organisation ID
1285
- - `--limit` - Maximum results (default: 500)
1286
-
1287
- #### `add-oidc-config`
1288
- **Usage:** `agilicus add-oidc-config NAME CLIENT_ID CLIENT_SECRET [OPTIONS]`
1289
-
1290
- Creates a new OIDC configuration.
1291
-
1292
- **Arguments:**
1293
- - `NAME` - Configuration name
1294
- - `CLIENT_ID` - OIDC client ID
1295
- - `CLIENT_SECRET` - OIDC client secret
1296
- - `--org-id` - Organisation ID
1297
- - `--issuer-url` - Issuer URL
1298
- - `--scopes` - OIDC scopes (multiple)
1299
- - `--enabled` - Enable configuration (boolean)
1300
-
1301
- #### `show-oidc-config`
1302
- **Usage:** `agilicus show-oidc-config CONFIG_ID [OPTIONS]`
1303
-
1304
- Shows OIDC configuration details.
1305
-
1306
- **Arguments:**
1307
- - `CONFIG_ID` - Configuration ID
1308
- - `--org-id` - Organisation ID
1309
-
1310
- #### `update-oidc-config`
1311
- **Usage:** `agilicus update-oidc-config CONFIG_ID [OPTIONS]`
1312
-
1313
- Updates an OIDC configuration.
1314
-
1315
- **Arguments:**
1316
- - `CONFIG_ID` - Configuration ID
1317
- - `--name` - Configuration name
1318
- - `--client-id` - OIDC client ID
1319
- - `--client-secret` - OIDC client secret
1320
- - `--org-id` - Organisation ID
1321
- - `--issuer-url` - Issuer URL
1322
- - `--scopes` - OIDC scopes (multiple)
1323
- - `--enabled` - Enable configuration (boolean)
1324
-
1325
- #### `delete-oidc-config`
1326
- **Usage:** `agilicus delete-oidc-config CONFIG_ID [OPTIONS]`
1327
-
1328
- Deletes an OIDC configuration.
1329
-
1330
- **Arguments:**
1331
- - `CONFIG_ID` - Configuration ID
1332
- - `--org-id` - Organisation ID
1333
-
1334
- ### Authentication Policies
1335
-
1336
- #### `list-auth-policies`
1337
- **Usage:** `agilicus list-auth-policies [OPTIONS]`
1338
-
1339
- Lists authentication policies.
1340
-
1341
- **Arguments:**
1342
- - `--org-id` - Organisation ID
1343
- - `--policy-type` - Policy type filter
1344
- - `--limit` - Maximum results (default: 500)
1345
-
1346
- #### `add-auth-policy`
1347
- **Usage:** `agilicus add-auth-policy NAME POLICY_TYPE [OPTIONS]`
1348
-
1349
- Creates a new authentication policy.
1350
-
1351
- **Arguments:**
1352
- - `NAME` - Policy name
1353
- - `POLICY_TYPE` - Policy type
1354
- - `--org-id` - Organisation ID
1355
- - `--description` - Policy description
1356
- - `--enabled` - Enable policy (boolean)
1357
- - `--rules` - Policy rules (JSON)
1358
-
1359
- #### `show-auth-policy`
1360
- **Usage:** `agilicus show-auth-policy POLICY_ID [OPTIONS]`
1361
-
1362
- Shows authentication policy details.
1363
-
1364
- **Arguments:**
1365
- - `POLICY_ID` - Policy ID
1366
- - `--org-id` - Organisation ID
1367
-
1368
- #### `update-auth-policy`
1369
- **Usage:** `agilicus update-auth-policy POLICY_ID [OPTIONS]`
1370
-
1371
- Updates an authentication policy.
1372
-
1373
- **Arguments:**
1374
- - `POLICY_ID` - Policy ID
1375
- - `--name` - Policy name
1376
- - `--policy-type` - Policy type
1377
- - `--org-id` - Organisation ID
1378
- - `--description` - Policy description
1379
- - `--enabled` - Enable policy (boolean)
1380
- - `--rules` - Policy rules (JSON)
1381
-
1382
- #### `delete-auth-policy`
1383
- **Usage:** `agilicus delete-auth-policy POLICY_ID [OPTIONS]`
1384
-
1385
- Deletes an authentication policy.
1386
-
1387
- **Arguments:**
1388
- - `POLICY_ID` - Policy ID
1389
- - `--org-id` - Organisation ID
1390
-
1391
- ---
1392
-
1393
- ## Billing
1394
-
1395
- Commands for managing billing accounts, subscriptions, products, and payment information.
1396
-
1397
- ### Billing Accounts
1398
-
1399
- #### `list-billing-accounts`
1400
- **Usage:** `agilicus list-billing-accounts [OPTIONS]`
1401
-
1402
- Lists billing accounts.
1403
-
1404
- **Arguments:**
1405
- - `--org-id` - Organisation ID
1406
- - `--account-status` - Account status filter
1407
- - `--limit` - Maximum results (default: 500)
1408
-
1409
- #### `add-billing-account`
1410
- **Usage:** `agilicus add-billing-account NAME [OPTIONS]`
1411
-
1412
- Creates a new billing account.
1413
-
1414
- **Arguments:**
1415
- - `NAME` - Account name
1416
- - `--org-id` - Organisation ID
1417
- - `--description` - Account description
1418
- - `--billing-email` - Billing email address
1419
- - `--payment-method` - Payment method
1420
-
1421
- #### `show-billing-account`
1422
- **Usage:** `agilicus show-billing-account ACCOUNT_ID [OPTIONS]`
1423
-
1424
- Shows billing account details.
1425
-
1426
- **Arguments:**
1427
- - `ACCOUNT_ID` - Account ID
1428
- - `--org-id` - Organisation ID
1429
-
1430
- #### `update-billing-account`
1431
- **Usage:** `agilicus update-billing-account ACCOUNT_ID [OPTIONS]`
1432
-
1433
- Updates a billing account.
1434
-
1435
- **Arguments:**
1436
- - `ACCOUNT_ID` - Account ID
1437
- - `--name` - Account name
1438
- - `--org-id` - Organisation ID
1439
- - `--description` - Account description
1440
- - `--billing-email` - Billing email address
1441
- - `--payment-method` - Payment method
1442
-
1443
- #### `delete-billing-account`
1444
- **Usage:** `agilicus delete-billing-account ACCOUNT_ID [OPTIONS]`
1445
-
1446
- Deletes a billing account.
1447
-
1448
- **Arguments:**
1449
- - `ACCOUNT_ID` - Account ID
1450
- - `--org-id` - Organisation ID
1451
-
1452
- ### Subscriptions
1453
-
1454
- #### `list-subscriptions`
1455
- **Usage:** `agilicus list-subscriptions [OPTIONS]`
1456
-
1457
- Lists subscriptions.
1458
-
1459
- **Arguments:**
1460
- - `--org-id` - Organisation ID
1461
- - `--billing-account-id` - Billing account ID
1462
- - `--subscription-status` - Subscription status filter
1463
- - `--limit` - Maximum results (default: 500)
1464
-
1465
- #### `add-subscription`
1466
- **Usage:** `agilicus add-subscription BILLING_ACCOUNT_ID PRODUCT_ID [OPTIONS]`
1467
-
1468
- Creates a new subscription.
1469
-
1470
- **Arguments:**
1471
- - `BILLING_ACCOUNT_ID` - Billing account ID
1472
- - `PRODUCT_ID` - Product ID
1473
- - `--org-id` - Organisation ID
1474
- - `--quantity` - Subscription quantity
1475
- - `--start-date` - Subscription start date
1476
-
1477
- #### `show-subscription`
1478
- **Usage:** `agilicus show-subscription SUBSCRIPTION_ID [OPTIONS]`
1479
-
1480
- Shows subscription details.
1481
-
1482
- **Arguments:**
1483
- - `SUBSCRIPTION_ID` - Subscription ID
1484
- - `--org-id` - Organisation ID
1485
-
1486
- #### `update-subscription`
1487
- **Usage:** `agilicus update-subscription SUBSCRIPTION_ID [OPTIONS]`
1488
-
1489
- Updates a subscription.
1490
-
1491
- **Arguments:**
1492
- - `SUBSCRIPTION_ID` - Subscription ID
1493
- - `--org-id` - Organisation ID
1494
- - `--quantity` - Subscription quantity
1495
- - `--product-id` - Product ID
1496
-
1497
- #### `cancel-subscription`
1498
- **Usage:** `agilicus cancel-subscription SUBSCRIPTION_ID [OPTIONS]`
1499
-
1500
- Cancels a subscription.
1501
-
1502
- **Arguments:**
1503
- - `SUBSCRIPTION_ID` - Subscription ID
1504
- - `--org-id` - Organisation ID
1505
- - `--cancel-date` - Cancellation date
1506
-
1507
- ### Products
1508
-
1509
- #### `list-products`
1510
- **Usage:** `agilicus list-products [OPTIONS]`
1511
-
1512
- Lists available products.
1513
-
1514
- **Arguments:**
1515
- - `--product-type` - Product type filter
1516
- - `--active-only` - Show only active products (boolean)
1517
- - `--limit` - Maximum results (default: 500)
1518
-
1519
- #### `show-product`
1520
- **Usage:** `agilicus show-product PRODUCT_ID`
1521
-
1522
- Shows product details.
1523
-
1524
- **Arguments:**
1525
- - `PRODUCT_ID` - Product ID
1526
-
1527
- ---
1528
-
1529
- ## Operations
1530
-
1531
- Commands for managing connectors, VPNs, organisations, features, clusters, audit destinations, points of presence, regions, and host bundles.
1532
-
1533
- ### Connectors
1534
-
1535
- #### `list-connectors`
1536
- **Usage:** `agilicus list-connectors [OPTIONS]`
1537
-
1538
- Lists connectors in the system.
1539
-
1540
- **Arguments:**
1541
- - `--org-id` - Organisation ID
1542
- - `--connector-type` - Connector type filter
1543
- - `--status` - Connector status filter
1544
- - `--limit` - Maximum results (default: 500)
1545
-
1546
- #### `add-connector`
1547
- **Usage:** `agilicus add-connector NAME CONNECTOR_TYPE [OPTIONS]`
1548
-
1549
- Creates a new connector.
1550
-
1551
- **Arguments:**
1552
- - `NAME` - Connector name
1553
- - `CONNECTOR_TYPE` - Connector type
1554
- - `--org-id` - Organisation ID
1555
- - `--description` - Connector description
1556
- - `--enabled` - Enable connector (boolean)
1557
- - `--config` - Connector configuration (JSON)
1558
-
1559
- #### `show-connector`
1560
- **Usage:** `agilicus show-connector CONNECTOR_ID [OPTIONS]`
1561
-
1562
- Shows connector details.
1563
-
1564
- **Arguments:**
1565
- - `CONNECTOR_ID` - Connector ID
1566
- - `--org-id` - Organisation ID
1567
-
1568
- #### `update-connector`
1569
- **Usage:** `agilicus update-connector CONNECTOR_ID [OPTIONS]`
1570
-
1571
- Updates a connector.
1572
-
1573
- **Arguments:**
1574
- - `CONNECTOR_ID` - Connector ID
1575
- - `--name` - Connector name
1576
- - `--connector-type` - Connector type
1577
- - `--org-id` - Organisation ID
1578
- - `--description` - Connector description
1579
- - `--enabled` - Enable connector (boolean)
1580
- - `--config` - Connector configuration (JSON)
1581
-
1582
- #### `delete-connector`
1583
- **Usage:** `agilicus delete-connector CONNECTOR_ID [OPTIONS]`
1584
-
1585
- Deletes a connector.
1586
-
1587
- **Arguments:**
1588
- - `CONNECTOR_ID` - Connector ID
1589
- - `--org-id` - Organisation ID
1590
-
1591
- #### `restart-connector`
1592
- **Usage:** `agilicus restart-connector CONNECTOR_ID [OPTIONS]`
1593
-
1594
- Restarts a connector.
1595
-
1596
- **Arguments:**
1597
- - `CONNECTOR_ID` - Connector ID
1598
- - `--org-id` - Organisation ID
1599
-
1600
- ### VPNs
1601
-
1602
- #### `list-vpns`
1603
- **Usage:** `agilicus list-vpns [OPTIONS]`
1604
-
1605
- Lists VPN configurations.
1606
-
1607
- **Arguments:**
1608
- - `--org-id` - Organisation ID
1609
- - `--vpn-type` - VPN type filter
1610
- - `--status` - VPN status filter
1611
- - `--limit` - Maximum results (default: 500)
1612
-
1613
- #### `add-vpn`
1614
- **Usage:** `agilicus add-vpn NAME VPN_TYPE [OPTIONS]`
1615
-
1616
- Creates a new VPN configuration.
1617
-
1618
- **Arguments:**
1619
- - `NAME` - VPN name
1620
- - `VPN_TYPE` - VPN type
1621
- - `--org-id` - Organisation ID
1622
- - `--description` - VPN description
1623
- - `--enabled` - Enable VPN (boolean)
1624
- - `--config` - VPN configuration (JSON)
1625
-
1626
- #### `show-vpn`
1627
- **Usage:** `agilicus show-vpn VPN_ID [OPTIONS]`
1628
-
1629
- Shows VPN configuration details.
1630
-
1631
- **Arguments:**
1632
- - `VPN_ID` - VPN ID
1633
- - `--org-id` - Organisation ID
1634
-
1635
- #### `update-vpn`
1636
- **Usage:** `agilicus update-vpn VPN_ID [OPTIONS]`
1637
-
1638
- Updates a VPN configuration.
1639
-
1640
- **Arguments:**
1641
- - `VPN_ID` - VPN ID
1642
- - `--name` - VPN name
1643
- - `--vpn-type` - VPN type
1644
- - `--org-id` - Organisation ID
1645
- - `--description` - VPN description
1646
- - `--enabled` - Enable VPN (boolean)
1647
- - `--config` - VPN configuration (JSON)
1648
-
1649
- #### `delete-vpn`
1650
- **Usage:** `agilicus delete-vpn VPN_ID [OPTIONS]`
1651
-
1652
- Deletes a VPN configuration.
1653
-
1654
- **Arguments:**
1655
- - `VPN_ID` - VPN ID
1656
- - `--org-id` - Organisation ID
1657
-
1658
- ### Organisations
1659
-
1660
- #### `list-organisations`
1661
- **Usage:** `agilicus list-organisations [OPTIONS]`
1662
-
1663
- Lists organisations.
1664
-
1665
- **Arguments:**
1666
- - `--parent-org-id` - Parent organisation ID
1667
- - `--org-type` - Organisation type filter
1668
- - `--status` - Organisation status filter
1669
- - `--limit` - Maximum results (default: 500)
1670
-
1671
- #### `add-organisation`
1672
- **Usage:** `agilicus add-organisation NAME [OPTIONS]`
1673
-
1674
- Creates a new organisation.
1675
-
1676
- **Arguments:**
1677
- - `NAME` - Organisation name
1678
- - `--parent-org-id` - Parent organisation ID
1679
- - `--org-type` - Organisation type
1680
- - `--description` - Organisation description
1681
- - `--enabled` - Enable organisation (boolean)
1682
-
1683
- #### `show-organisation`
1684
- **Usage:** `agilicus show-organisation ORG_ID`
1685
-
1686
- Shows organisation details.
1687
-
1688
- **Arguments:**
1689
- - `ORG_ID` - Organisation ID
1690
-
1691
- #### `update-organisation`
1692
- **Usage:** `agilicus update-organisation ORG_ID [OPTIONS]`
1693
-
1694
- Updates an organisation.
1695
-
1696
- **Arguments:**
1697
- - `ORG_ID` - Organisation ID
1698
- - `--name` - Organisation name
1699
- - `--parent-org-id` - Parent organisation ID
1700
- - `--org-type` - Organisation type
1701
- - `--description` - Organisation description
1702
- - `--enabled` - Enable organisation (boolean)
1703
-
1704
- #### `delete-organisation`
1705
- **Usage:** `agilicus delete-organisation ORG_ID`
1706
-
1707
- Deletes an organisation.
1708
-
1709
- **Arguments:**
1710
- - `ORG_ID` - Organisation ID
1711
-
1712
- ### Features
1713
-
1714
- #### `list-features`
1715
- **Usage:** `agilicus list-features [OPTIONS]`
1716
-
1717
- Lists system features.
1718
-
1719
- **Arguments:**
1720
- - `--org-id` - Organisation ID
1721
- - `--feature-type` - Feature type filter
1722
- - `--enabled-only` - Show only enabled features (boolean)
1723
- - `--limit` - Maximum results (default: 500)
1724
-
1725
- #### `enable-feature`
1726
- **Usage:** `agilicus enable-feature FEATURE_NAME [OPTIONS]`
1727
-
1728
- Enables a system feature.
1729
-
1730
- **Arguments:**
1731
- - `FEATURE_NAME` - Feature name
1732
- - `--org-id` - Organisation ID
1733
-
1734
- #### `disable-feature`
1735
- **Usage:** `agilicus disable-feature FEATURE_NAME [OPTIONS]`
1736
-
1737
- Disables a system feature.
1738
-
1739
- **Arguments:**
1740
- - `FEATURE_NAME` - Feature name
1741
- - `--org-id` - Organisation ID
1742
-
1743
- ### Clusters
1744
-
1745
- #### `list-clusters`
1746
- **Usage:** `agilicus list-clusters [OPTIONS]`
1747
-
1748
- Lists clusters.
1749
-
1750
- **Arguments:**
1751
- - `--cluster-type` - Cluster type filter
1752
- - `--status` - Cluster status filter
1753
- - `--region` - Region filter
1754
- - `--limit` - Maximum results (default: 500)
1755
-
1756
- #### `show-cluster`
1757
- **Usage:** `agilicus show-cluster CLUSTER_ID`
1758
-
1759
- Shows cluster details.
1760
-
1761
- **Arguments:**
1762
- - `CLUSTER_ID` - Cluster ID
1763
-
1764
- ### Audit Destinations
1765
-
1766
- #### `list-audit-destinations`
1767
- **Usage:** `agilicus list-audit-destinations [OPTIONS]`
1768
-
1769
- Lists audit destinations.
1770
-
1771
- **Arguments:**
1772
- - `--org-id` - Organisation ID
1773
- - `--destination-type` - Destination type filter
1774
- - `--enabled-only` - Show only enabled destinations (boolean)
1775
- - `--limit` - Maximum results (default: 500)
1776
-
1777
- #### `add-audit-destination`
1778
- **Usage:** `agilicus add-audit-destination NAME DESTINATION_TYPE [OPTIONS]`
1779
-
1780
- Creates a new audit destination.
1781
-
1782
- **Arguments:**
1783
- - `NAME` - Destination name
1784
- - `DESTINATION_TYPE` - Destination type
1785
- - `--org-id` - Organisation ID
1786
- - `--description` - Destination description
1787
- - `--enabled` - Enable destination (boolean)
1788
- - `--config` - Destination configuration (JSON)
1789
-
1790
- #### `show-audit-destination`
1791
- **Usage:** `agilicus show-audit-destination DESTINATION_ID [OPTIONS]`
1792
-
1793
- Shows audit destination details.
1794
-
1795
- **Arguments:**
1796
- - `DESTINATION_ID` - Destination ID
1797
- - `--org-id` - Organisation ID
1798
-
1799
- #### `update-audit-destination`
1800
- **Usage:** `agilicus update-audit-destination DESTINATION_ID [OPTIONS]`
1801
-
1802
- Updates an audit destination.
1803
-
1804
- **Arguments:**
1805
- - `DESTINATION_ID` - Destination ID
1806
- - `--name` - Destination name
1807
- - `--destination-type` - Destination type
1808
- - `--org-id` - Organisation ID
1809
- - `--description` - Destination description
1810
- - `--enabled` - Enable destination (boolean)
1811
- - `--config` - Destination configuration (JSON)
1812
-
1813
- #### `delete-audit-destination`
1814
- **Usage:** `agilicus delete-audit-destination DESTINATION_ID [OPTIONS]`
1815
-
1816
- Deletes an audit destination.
1817
-
1818
- **Arguments:**
1819
- - `DESTINATION_ID` - Destination ID
1820
- - `--org-id` - Organisation ID
1821
-
1822
- ### Points of Presence (PoP)
1823
-
1824
- #### `list-pops`
1825
- **Usage:** `agilicus list-pops [OPTIONS]`
1826
-
1827
- Lists points of presence.
1828
-
1829
- **Arguments:**
1830
- - `--region` - Region filter
1831
- - `--status` - PoP status filter
1832
- - `--limit` - Maximum results (default: 500)
1833
-
1834
- #### `show-pop`
1835
- **Usage:** `agilicus show-pop POP_ID`
1836
-
1837
- Shows point of presence details.
1838
-
1839
- **Arguments:**
1840
- - `POP_ID` - PoP ID
1841
-
1842
- ### Regions
1843
-
1844
- #### `list-regions`
1845
- **Usage:** `agilicus list-regions [OPTIONS]`
1846
-
1847
- Lists available regions.
1848
-
1849
- **Arguments:**
1850
- - `--region-type` - Region type filter
1851
- - `--active-only` - Show only active regions (boolean)
1852
- - `--limit` - Maximum results (default: 500)
1853
-
1854
- #### `show-region`
1855
- **Usage:** `agilicus show-region REGION_ID`
1856
-
1857
- Shows region details.
1858
-
1859
- **Arguments:**
1860
- - `REGION_ID` - Region ID
1861
-
1862
- ### Host Bundles
1863
-
1864
- #### `list-host-bundles`
1865
- **Usage:** `agilicus list-host-bundles [OPTIONS]`
1866
-
1867
- Lists host bundles.
1868
-
1869
- **Arguments:**
1870
- - `--org-id` - Organisation ID
1871
- - `--bundle-type` - Bundle type filter
1872
- - `--status` - Bundle status filter
1873
- - `--limit` - Maximum results (default: 500)
1874
-
1875
- #### `add-host-bundle`
1876
- **Usage:** `agilicus add-host-bundle NAME BUNDLE_TYPE [OPTIONS]`
1877
-
1878
- Creates a new host bundle.
1879
-
1880
- **Arguments:**
1881
- - `NAME` - Bundle name
1882
- - `BUNDLE_TYPE` - Bundle type
1883
- - `--org-id` - Organisation ID
1884
- - `--description` - Bundle description
1885
- - `--config` - Bundle configuration (JSON)
1886
-
1887
- #### `show-host-bundle`
1888
- **Usage:** `agilicus show-host-bundle BUNDLE_ID [OPTIONS]`
1889
-
1890
- Shows host bundle details.
1891
-
1892
- **Arguments:**
1893
- - `BUNDLE_ID` - Bundle ID
1894
- - `--org-id` - Organisation ID
1895
-
1896
- #### `update-host-bundle`
1897
- **Usage:** `agilicus update-host-bundle BUNDLE_ID [OPTIONS]`
1898
-
1899
- Updates a host bundle.
1900
-
1901
- **Arguments:**
1902
- - `BUNDLE_ID` - Bundle ID
1903
- - `--name` - Bundle name
1904
- - `--bundle-type` - Bundle type
1905
- - `--org-id` - Organisation ID
1906
- - `--description` - Bundle description
1907
- - `--config` - Bundle configuration (JSON)
1908
-
1909
- #### `delete-host-bundle`
1910
- **Usage:** `agilicus delete-host-bundle BUNDLE_ID [OPTIONS]`
1911
-
1912
- Deletes a host bundle.
1913
-
1914
- **Arguments:**
1915
- - `BUNDLE_ID` - Bundle ID
1916
- - `--org-id` - Organisation ID
1917
-
1918
- ---
1919
-
1920
- ## Policy
1921
-
1922
- Commands for managing policy rules and access control policies.
1923
-
1924
- ### Policy Rules
1925
-
1926
- #### `list-policy-rules`
1927
- **Usage:** `agilicus list-policy-rules [OPTIONS]`
1928
-
1929
- Lists policy rules.
1930
-
1931
- **Arguments:**
1932
- - `--org-id` - Organisation ID
1933
- - `--rule-type` - Rule type filter
1934
- - `--resource-type` - Resource type filter
1935
- - `--enabled-only` - Show only enabled rules (boolean)
1936
- - `--limit` - Maximum results (default: 500)
1937
-
1938
- #### `add-policy-rule`
1939
- **Usage:** `agilicus add-policy-rule NAME RULE_TYPE [OPTIONS]`
1940
-
1941
- Creates a new policy rule.
1942
-
1943
- **Arguments:**
1944
- - `NAME` - Rule name
1945
- - `RULE_TYPE` - Rule type
1946
- - `--org-id` - Organisation ID
1947
- - `--description` - Rule description
1948
- - `--enabled` - Enable rule (boolean)
1949
- - `--conditions` - Rule conditions (JSON)
1950
- - `--actions` - Rule actions (JSON)
1951
- - `--priority` - Rule priority
1952
-
1953
- #### `show-policy-rule`
1954
- **Usage:** `agilicus show-policy-rule RULE_ID [OPTIONS]`
1955
-
1956
- Shows policy rule details.
1957
-
1958
- **Arguments:**
1959
- - `RULE_ID` - Rule ID
1960
- - `--org-id` - Organisation ID
1961
-
1962
- #### `update-policy-rule`
1963
- **Usage:** `agilicus update-policy-rule RULE_ID [OPTIONS]`
1964
-
1965
- Updates a policy rule.
1966
-
1967
- **Arguments:**
1968
- - `RULE_ID` - Rule ID
1969
- - `--name` - Rule name
1970
- - `--rule-type` - Rule type
1971
- - `--org-id` - Organisation ID
1972
- - `--description` - Rule description
1973
- - `--enabled` - Enable rule (boolean)
1974
- - `--conditions` - Rule conditions (JSON)
1975
- - `--actions` - Rule actions (JSON)
1976
- - `--priority` - Rule priority
1977
-
1978
- #### `delete-policy-rule`
1979
- **Usage:** `agilicus delete-policy-rule RULE_ID [OPTIONS]`
1980
-
1981
- Deletes a policy rule.
1982
-
1983
- **Arguments:**
1984
- - `RULE_ID` - Rule ID
1985
- - `--org-id` - Organisation ID
1986
-
1987
- #### `enable-policy-rule`
1988
- **Usage:** `agilicus enable-policy-rule RULE_ID [OPTIONS]`
1989
-
1990
- Enables a policy rule.
1991
-
1992
- **Arguments:**
1993
- - `RULE_ID` - Rule ID
1994
- - `--org-id` - Organisation ID
1995
-
1996
- #### `disable-policy-rule`
1997
- **Usage:** `agilicus disable-policy-rule RULE_ID [OPTIONS]`
1998
-
1999
- Disables a policy rule.
2000
-
2001
- **Arguments:**
2002
- - `RULE_ID` - Rule ID
2003
- - `--org-id` - Organisation ID
2004
-
2005
- ---
2006
-
2007
- ## Miscellaneous
2008
-
2009
- Additional utility commands and system operations.
2010
-
2011
- ### System Information
2012
-
2013
- #### `version`
2014
- **Usage:** `agilicus version`
2015
-
2016
- Shows the CLI version information.
2017
-
2018
- #### `config`
2019
- **Usage:** `agilicus config [OPTIONS]`
2020
-
2021
- Shows or sets CLI configuration.
2022
-
2023
- **Arguments:**
2024
- - `--show` - Show current configuration
2025
- - `--set` - Set configuration value (key=value format)
2026
- - `--unset` - Unset configuration key
2027
-
2028
- #### `login`
2029
- **Usage:** `agilicus login [OPTIONS]`
2030
-
2031
- Authenticates with the Agilicus platform.
2032
-
2033
- **Arguments:**
2034
- - `--username` - Username for authentication
2035
- - `--password` - Password for authentication
2036
- - `--token` - Authentication token
2037
- - `--org-id` - Organisation ID
2038
-
2039
- #### `logout`
2040
- **Usage:** `agilicus logout`
2041
-
2042
- Logs out from the Agilicus platform.
2043
-
2044
- #### `whoami`
2045
- **Usage:** `agilicus whoami`
2046
-
2047
- Shows current user information.
2048
-
2049
- ### Data Export/Import
2050
-
2051
- #### `export`
2052
- **Usage:** `agilicus export [OPTIONS]`
2053
-
2054
- Exports data from the system.
2055
-
2056
- **Arguments:**
2057
- - `--org-id` - Organisation ID
2058
- - `--resource-type` - Resource type to export
2059
- - `--format` - Export format (json/csv/yaml)
2060
- - `--output` - Output file path
2061
-
2062
- #### `import`
2063
- **Usage:** `agilicus import FILE [OPTIONS]`
2064
-
2065
- Imports data into the system.
2066
-
2067
- **Arguments:**
2068
- - `FILE` - Import file path
2069
- - `--org-id` - Organisation ID
2070
- - `--format` - Import format (json/csv/yaml)
2071
- - `--dry-run` - Perform dry run without making changes
2072
-
2073
- ### Utilities
2074
-
2075
- #### `validate`
2076
- **Usage:** `agilicus validate FILE [OPTIONS]`
2077
-
2078
- Validates configuration files.
2079
-
2080
- **Arguments:**
2081
- - `FILE` - Configuration file to validate
2082
- - `--schema` - Schema to validate against
2083
- - `--format` - File format (json/yaml)
2084
-
2085
- #### `generate`
2086
- **Usage:** `agilicus generate TYPE [OPTIONS]`
2087
-
2088
- Generates configuration templates.
2089
-
2090
- **Arguments:**
2091
- - `TYPE` - Template type to generate
2092
- - `--output` - Output file path
2093
- - `--format` - Output format (json/yaml)
2094
-
2095
- #### `health`
2096
- **Usage:** `agilicus health [OPTIONS]`
2097
-
2098
- Checks system health status.
2099
-
2100
- **Arguments:**
2101
- - `--org-id` - Organisation ID
2102
- - `--component` - Specific component to check
2103
- - `--verbose` - Verbose output
2104
-
2105
- ---
2106
-
2107
- This comprehensive CLI reference covers all available commands in the Agilicus CLI tool, organized by functional categories for easy navigation and reference.