/
Panorama.yml
9420 lines (9420 loc) · 360 KB
/
Panorama.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
category: Network Security
sectionorder:
- Connect
- Collect
commonfields:
id: Panorama
version: -1
configuration:
- display: Server URL (e.g., https://192.168.0.1)
name: server
required: true
type: 0
section: Connect
- displaypassword: API Key
name: credentials
type: 9
hiddenusername: true
section: Connect
required: false
- defaultvalue: '443'
display: Port (e.g 443)
name: port
type: 0
section: Connect
advanced: true
required: false
- additionalinfo: Located in the Panorama UI. Go to Panorama, Device Groups and select the desired Device Group
display: Device group - Panorama instances only (write shared for Shared location)
name: device_group
type: 0
section: Connect
advanced: true
required: false
- additionalinfo: Located in the Firewall URL; by default of PAN-OS it is vsys1
display: Vsys - Firewall instances only
name: vsys
type: 0
section: Connect
required: false
- display: Template - Panorama instances only
name: template
type: 0
section: Connect
advanced: true
required: false
- additionalinfo: If selected, when running the !url command, the command will execute using pan-os with PAN_DB (with applied filters). The URL filtering categories determine DBot score (malicious, suspicious, benign).
display: Use URL Filtering for auto enrichment
name: use_url_filtering
type: 8
section: Collect
advanced: true
required: false
- display: URL Filtering Additional suspicious categories. CSV list of categories that will be considered suspicious.
name: additional_suspicious
type: 12
section: Collect
advanced: true
required: false
- display: URL Filtering Additional malicious categories. CSV list of categories that will be considered malicious.
name: additional_malicious
type: 12
section: Collect
advanced: true
required: false
- display: Trust any certificate (not secure)
name: insecure
type: 8
section: Connect
advanced: true
required: false
- display: Use system proxy settings
name: proxy
type: 8
section: Connect
advanced: true
required: false
- display: API Key (Deprecated)
name: key
type: 4
hidden: true
additionalinfo: Use the "API Key (Recommended)" parameter instead.
section: Connect
advanced: true
required: false
- additionalinfo: Reliability of the source providing the intelligence data.
defaultvalue: B - Usually reliable
display: Source Reliability
name: integrationReliability
options:
- A+ - 3rd party enrichment
- A - Completely reliable
- B - Usually reliable
- C - Fairly reliable
- D - Not usually reliable
- E - Unreliable
- F - Reliability cannot be judged
type: 15
section: Collect
advanced: true
required: false
- defaultvalue: indicatorType
name: feedExpirationPolicy
display: ''
options:
- never
- interval
- indicatorType
- suddenDeath
type: 17
section: Collect
advanced: true
required: false
- defaultvalue: '20160'
name: feedExpirationInterval
display: ''
type: 1
section: Collect
advanced: true
required: false
- display: Fetch incidents
name: isFetch
type: 8
section: Collect
required: false
- defaultvalue: 24 hours
display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
name: first_fetch
type: 0
section: Collect
required: false
- defaultvalue: "100"
display: Max incidents per fetch (for each selected Log Type Query)
additionalinfo: The maximum number of incidents to fetch per Log Type Query. To ensure optimal efficiency, it is strongly advised to keep the limit as low as possible.
name: max_fetch
type: 0
section: Collect
required: false
- display: Log Type
name: log_types
type: 16
additionalinfo: "Select which log types to fetch.\nSelecting 'All' will use all the log type queries in the fetch.\nTo choose a specific set of queries, select their log types from the dropdown (make sure the 'All' option is unselected)."
options:
- Traffic
- Threat
- Url
- Data
- Correlation
- System
- Wildfire
- Decryption
- All
section: Connect
advanced: true
required: false
- display: Log type max number of job pulling attempts
name: fetch_job_polling_max_num_attempts
additionalinfo: "The maximum number of attempts to try and pull results for each log type from a job that was created by its query. Each attempt takes around 1 second. Increasing this value is useful in case there are many logs to pull from a given log type.\nNote: When increasing this number, in case fetching more than 4 logs types together, it is recommended to split different log types for different integration instances"
type: 0
defaultvalue: 10
advanced: true
section: Collect
- display: Traffic Log Type Query
name: traffic_query
additionalinfo: "Traffic Log Type query example: (addr.src in {source}) and (addr.dst in {destination}) and (action eq {action}).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: Threat Log Type Query
name: threat_query
additionalinfo: "Threat Log Type query example: (severity geq high).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: URL Log Type Query
name: url_query
additionalinfo: "URL Log Type query example: ((action eq block-override) or (action eq block-url)) and (severity geq high).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: Data Log Type Query
name: data_query
additionalinfo: "Data Log Type query example: ((action eq alert) or (action eq wildfire-upload-success) or (action eq forward)) and (severity geq high).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: Correlation Log Type Query
name: correlation_query
additionalinfo: "Correlation Log Type query example: (hostid eq {host_id}) and (match_time in {last_x_time}) and (objectname eq {object_name}) and (severity geq '{severity}'') and (src in {source_address}).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: System Log Type Query
name: system_query
additionalinfo: "System Log Type query example: (subtype eq {sub_type}) and (severity geq {severity}). \nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: Wildfire Submission Log Type Query
name: wildfire_query
additionalinfo: "Wildfire Submission Log Type query example: ((action eq wildfire-upload-fail) or (action eq wildfire-upload-skip) or (action eq sinkhole)). \nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: Decryption Log Type Query
name: decryption_query
additionalinfo: "Decryption Log Type query example: (app eq {application}) and (policy_name geq {policy_name}) and ((src in {source}) or (dst in {destination})). \nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
type: 12
section: Collect
advanced: true
required: false
- display: Incident type
name: incidentType
type: 13
section: Connect
required: false
description: Manage Palo Alto Networks Firewall and Panorama. Use this pack to manage Prisma Access through Panorama. For more information, see the Panorama documentation.
display: Palo Alto Networks PAN-OS
name: Panorama
script:
commands:
- arguments:
- auto: PREDEFINED
description: Action to be taken, such as show, get, set, edit, delete, rename, clone, move, override, multi-move, multi-clone, or complete.
name: action
predefined:
- set
- edit
- delete
- rename
- clone
- move
- override
- muti-move
- multi-clone
- complete
- show
- get
- description: The category parameter. For example, when exporting a configuration file, use "category=configuration".
name: category
- description: The XML structure that defines the command. Used for operation commands.
name: cmd
- description: The command to run. For example, command =<show><arp><entry name='all'/></arp></show>.
name: command
- description: The specified destination.
name: dst
- description: The new value defined for an object.
name: element
- description: The end time (used when cloning an object).
name: to
- description: The start time (used when cloning an object).
name: from
- description: The key value to set.
name: key
- description: The log type to retrieve. For example, log-type=threat for threat logs.
name: log-type
- description: The type of move operation (for example, where=after, where=before, where=top, where=bottom).
name: where
- description: The time period. For example, period=last-24-hrs.
name: period
- description: The xpath location. For example, xpath=/config/predefined/application/entry[@name='hotmail'].
name: xpath
- description: The PCAP ID included in the threat log.
name: pcap-id
- description: The device serial number.
name: serialno
- description: The report type, for example dynamic, predefined, or custom.
name: reporttype
- description: The report name.
name: reportname
- defaultValue: keygen,config,commit,op,report,log,import,export,user-id,version
description: The request type, for example export, import, log, config.
name: type
- description: The time the PCAP was received on the firewall. Used for threat PCAPs.
name: search-time
- description: The target number of the firewall. Used only on a Panorama instance.
name: target
- description: The job ID.
name: job-id
- description: The query string.
name: query
- description: The name of the virtual system to be configured. If no vsys is mentioned, this command will not use the vsys parameter.
name: vsys
description: Runs any command supported in the API.
deprecated: true
name: panorama
- arguments:
- description: The firewall managed by Panorama from which to retrieve the predefined threats.
name: target
description: Gets the predefined threats list from a firewall or Panorama and stores it as a JSON file in the context.
deprecated: true
name: panorama-get-predefined-threats-list
outputs:
- contextPath: File.Size
description: The file size.
type: number
- contextPath: File.Name
description: The file name.
type: string
- contextPath: File.Type
description: The file type.
type: string
- contextPath: File.Info
description: The file information.
type: string
- contextPath: File.Extension
description: The file extension.
type: string
- contextPath: File.EntryID
description: The file entry ID.
type: string
- contextPath: File.MD5
description: The MD5 hash of the file.
type: string
- contextPath: File.SHA1
description: The SHA1 hash of the file.
type: string
- contextPath: File.SHA256
description: The SHA256 hash of the file.
type: string
- contextPath: File.SHA512
description: The SHA512 hash of the file.
type: string
- contextPath: File.SSDeep
description: The SSDeep hash of the file.
type: string
- arguments:
- description: The commit description.
name: description
- description: The administrator name. To commit admin-level changes on a firewall, include the administrator name in the request.
name: admin_name
- auto: PREDEFINED
description: Forces a commit.
name: force_commit
predefined:
- 'true'
- 'false'
- auto: PREDEFINED
description: Performs a partial commit while excluding device and network configuration.
name: exclude_device_network_configuration
predefined:
- 'true'
- 'false'
- auto: PREDEFINED
description: Performs a partial commit while excluding shared objects.
name: exclude_shared_objects
predefined:
- 'true'
- 'false'
description: Commits a configuration to the Palo Alto firewall or Panorama, but does not validate if the commit was successful. Committing to Panorama does not push the configuration to the firewalls. To push the configuration, run the panorama-push-to-device-group command.
deprecated: true
name: panorama-commit
outputs:
- contextPath: Panorama.Commit.JobID
description: The job ID to commit.
type: number
- contextPath: Panorama.Commit.Status
description: The commit status.
type: string
- arguments:
- default: true
description: The device group to which to push (Panorama instances).
name: device-group
- auto: PREDEFINED
defaultValue: 'false'
description: Pre policy validation.
name: validate-only
predefined:
- 'true'
- 'false'
- auto: PREDEFINED
defaultValue: 'true'
description: Whether to include template changes.
name: include-template
predefined:
- 'true'
- 'false'
- description: The push description.
name: description
- description: The serial number for a virtual system commit. If provided, the commit will be a virtual system commit.
name: serial_number
description: Pushes rules from PAN-OS to the configured device group. In order to push the configuration to Prisma Access managed tenants (single or multi- tenancy), use the device group argument with the device group associated with the tenant ID.
deprecated: true
name: panorama-push-to-device-group
outputs:
- contextPath: Panorama.Push.DeviceGroup
description: The device group in which the policies were pushed.
type: String
- contextPath: Panorama.Push.JobID
description: The job ID of the policies that were pushed.
type: Number
- contextPath: Panorama.Push.Status
description: The push status.
type: String
- contextPath: Panorama.Push.Warnings
description: The push warnings.
type: String
- contextPath: Panorama.Push.Errors
description: The push errors.
type: String
- arguments:
- default: true
description: The template to push.
name: template
- auto: PREDEFINED
defaultValue: 'false'
description: Whether to validate the policy.
name: validate-only
predefined:
- 'true'
- 'false'
- description: The push description.
name: description
- description: The serial number for a virtual system commit. If provided, the commit will be a virtual system commit.
name: serial_number
description: Pushes the given PAN-OS template to the given devices or all devices that belong to the template.
name: pan-os-push-to-template
outputs:
- contextPath: Panorama.Push.Template
description: The device group in which the policies were pushed.
type: String
- contextPath: Panorama.Push.JobID
description: The job ID of the policies that were pushed.
type: Number
- contextPath: Panorama.Push.Status
description: The push status.
type: String
- contextPath: Panorama.Push.Warnings
description: The push warnings.
type: String
- contextPath: Panorama.Push.Errors
description: The push errors.
type: String
- arguments:
- description: The template-stack to push.
name: template-stack
required: true
- auto: PREDEFINED
defaultValue: 'false'
description: Whether to validate the policy.
name: validate-only
predefined:
- 'true'
- 'false'
- description: The push description.
name: description
- description: The serial number for a virtual system commit. If provided, the commit will be a virtual system commit.
name: serial_number
description: Pushes the given PAN-OS template-stack to the given devices or all devices that belong to the template stack.
name: pan-os-push-to-template-stack
outputs:
- contextPath: Panorama.Push.TemplateStack
description: The device group in which the policies were pushed.
type: String
- contextPath: Panorama.Push.JobID
description: The job ID of the policies that were pushed.
type: Number
- contextPath: Panorama.Push.Status
description: The push status.
type: String
- contextPath: Panorama.Push.Warnings
description: The push warnings.
type: String
- contextPath: Panorama.Push.Errors
description: The push errors.
type: String
- arguments:
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tag for which to filter the list of addresses.
name: tag
description: Returns a list of addresses.
deprecated: true
name: panorama-list-addresses
outputs:
- contextPath: Panorama.Addresses.Name
description: The address name.
type: string
- contextPath: Panorama.Addresses.Description
description: The address description.
type: string
- contextPath: Panorama.Addresses.FQDN
description: The address FQDN.
type: string
- contextPath: Panorama.Addresses.IP_Netmask
description: The address IP Netmask.
type: string
- contextPath: Panorama.Addresses.IP_Range
description: The address IP range.
type: string
- contextPath: Panorama.Addresses.DeviceGroup
description: The address device group.
type: String
- contextPath: Panorama.Addresses.Tags
description: The address tags.
type: String
- arguments:
- description: The address name.
name: name
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
description: Returns address details for the supplied address name.
deprecated: true
name: panorama-get-address
outputs:
- contextPath: Panorama.Addresses.Name
description: The address name.
type: string
- contextPath: Panorama.Addresses.Description
description: The address description.
type: string
- contextPath: Panorama.Addresses.FQDN
description: The address FQDN.
type: string
- contextPath: Panorama.Addresses.IP_Netmask
description: The address IP netmask.
type: string
- contextPath: Panorama.Addresses.IP_Range
description: The address IP range.
type: string
- contextPath: Panorama.Addresses.DeviceGroup
description: The device group for the address (Panorama instances).
type: String
- contextPath: Panorama.Addresses.Tags
description: The address tags.
type: String
- arguments:
- description: The new address name.
name: name
required: true
- description: The new address description.
name: description
- description: The FQDN of the new address.
name: fqdn
- description: The IP Netmask of the new address. For example, 10.10.10.10/24.
name: ip_netmask
- description: The IP range of the new address IP. For example, 10.10.10.0-10.10.10.255.
name: ip_range
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tag for the new address.
isArray: true
name: tag
- auto: PREDEFINED
description: Whether to create the tag if it does not exist.
defaultValue: 'false'
name: create_tag
predefined:
- 'true'
- 'false'
description: Creates an address object.
deprecated: true
name: panorama-create-address
outputs:
- contextPath: Panorama.Addresses.Name
description: The address name.
type: string
- contextPath: Panorama.Addresses.Description
description: The address description.
type: string
- contextPath: Panorama.Addresses.FQDN
description: The address FQDN.
type: string
- contextPath: Panorama.Addresses.IP_Netmask
description: The address IP netmask.
type: string
- contextPath: Panorama.Addresses.IP_Range
description: The address IP range.
type: string
- contextPath: Panorama.Addresses.DeviceGroup
description: The device group for the address (Panorama instances).
type: String
- contextPath: Panorama.Addresses.Tags
description: The address tags.
type: String
- arguments:
- description: The name of the address to delete.
name: name
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
description: Deletes an address object.
deprecated: true
name: panorama-delete-address
outputs:
- contextPath: Panorama.Addresses.Name
description: The address name that was deleted.
type: string
- contextPath: Panorama.Addresses.DeviceGroup
description: The device group for the address (Panorama instances).
type: String
- arguments:
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tag for which to filter the address groups.
name: tag
description: Returns a list of address groups.
deprecated: true
name: panorama-list-address-groups
outputs:
- contextPath: Panorama.AddressGroups.Name
description: The address group name.
type: string
- contextPath: Panorama.AddressGroups.Type
description: The address group type.
type: string
- contextPath: Panorama.AddressGroups.Match
description: The dynamic address group match.
type: string
- contextPath: Panorama.AddressGroups.Description
description: The address group description.
type: string
- contextPath: Panorama.AddressGroups.Addresses
description: The static address group addresses.
type: String
- contextPath: Panorama.AddressGroups.DeviceGroup
description: The device group for the address group (Panorama instances).
type: String
- contextPath: Panorama.AddressGroups.Tags
description: The address group tags.
type: String
- arguments:
- description: The address group name.
name: name
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
description: Gets details for the specified address group.
deprecated: true
name: panorama-get-address-group
outputs:
- contextPath: Panorama.AddressGroups.Name
description: The address group name.
type: string
- contextPath: Panorama.AddressGroups.Type
description: The address group type.
type: string
- contextPath: Panorama.AddressGroups.Match
description: The dynamic address group match.
type: string
- contextPath: Panorama.AddressGroups.Description
description: The address group description.
type: string
- contextPath: Panorama.AddressGroups.Addresses
description: The static address group addresses.
type: string
- contextPath: Panorama.AddressGroups.DeviceGroup
description: The device group for the address group (Panorama instances).
type: String
- contextPath: Panorama.AddressGroups.Tags
description: The address group tags.
type: String
- arguments:
- description: The address group name.
name: name
required: true
- auto: PREDEFINED
description: The address group type.
name: type
predefined:
- dynamic
- static
required: true
- description: The dynamic address group match. For example "1.1.1.1 or 2.2.2.2".
name: match
- description: The static address group list of addresses.
isArray: true
name: addresses
- description: The address group description.
name: description
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tags for the address group.
isArray: true
name: tags
description: Creates a static or dynamic address group.
deprecated: true
name: panorama-create-address-group
outputs:
- contextPath: Panorama.AddressGroups.Name
description: The address group name.
type: string
- contextPath: Panorama.AddressGroups.Type
description: The address group type.
type: string
- contextPath: Panorama.AddressGroups.Match
description: The dynamic address group match.
type: string
- contextPath: Panorama.AddressGroups.Addresses
description: The static address group list of addresses.
type: string
- contextPath: Panorama.AddressGroups.Description
description: The address group description.
type: string
- contextPath: Panorama.AddressGroups.DeviceGroup
description: The device group for the address group (Panorama instances).
type: String
- contextPath: Panorama.AddressGroups.Tags
description: The address group tags.
type: String
- arguments:
- auto: PREDEFINED
description: 'The session rejection type. Possible values are: "drop", "alert", "block-ip", "reset-both", "reset-client", and "reset-server". Default is "drop".'
name: drop_mode
predefined:
- drop
- alert
- block-ip
- reset-both
- reset-client
- reset-server
- description: The name of the vulnerability profile.
name: vulnerability_profile
required: true
- description: The numerical threat ID.
name: threat_id
required: true
description: Sets a vulnerability signature to block mode.
deprecated: true
name: panorama-block-vulnerability
outputs:
- contextPath: Panorama.Vulnerability.ID
description: The ID of the vulnerability that was blocked/overridden.
type: string
- contextPath: Panorama.Vulnerability.NewAction
description: The new action for the vulnerability.
type: string
- arguments:
- description: The name of the address group to delete.
name: name
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
description: Deletes an address group.
deprecated: true
name: panorama-delete-address-group
outputs:
- contextPath: Panorama.AddressGroups.Name
description: The name of the address group that was deleted.
type: string
- contextPath: Panorama.AddressGroups.DeviceGroup
description: The device group for the address group (Panorama instances).
type: String
- arguments:
- description: The name of the address group to edit.
name: name
required: true
- auto: PREDEFINED
description: The address group type.
name: type
predefined:
- static
- dynamic
required: true
- description: The address group new match. For example, '1.1.1.1 and 2.2.2.2'.
name: match
- description: The element to add to the list of the static address group. Only existing address objects can be added.
name: element_to_add
- description: The element to remove from the list of the static address group. Only existing address objects can be removed.
name: element_to_remove
- description: The address group new description.
name: description
- description: The tag of the address group to edit.
isArray: true
name: tags
description: Edits a static or dynamic address group.
deprecated: true
name: panorama-edit-address-group
outputs:
- contextPath: Panorama.AddressGroups.Name
description: The address group name.
type: string
- contextPath: Panorama.AddressGroups.Type
description: The address group type.
type: string
- contextPath: Panorama.AddressGroups.Filter
description: The dynamic address group match.
type: string
- contextPath: Panorama.AddressGroups.Description
description: The address group description.
type: string
- contextPath: Panorama.AddressGroups.Addresses
description: The static address group addresses.
type: string
- contextPath: Panorama.AddressGroups.DeviceGroup
description: The device group for the address group (Panorama instances).
type: String
- contextPath: Panorama.AddressGroups.Tags
description: The address group tags.
type: String
- arguments:
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tag for which to filter the services.
name: tag
description: Returns a list of addresses.
deprecated: true
name: panorama-list-services
outputs:
- contextPath: Panorama.Services.Name
description: The service name.
type: string
- contextPath: Panorama.Services.Protocol
description: The service protocol.
type: string
- contextPath: Panorama.Services.Description
description: The service description.
type: string
- contextPath: Panorama.Services.DestinationPort
description: The service destination port.
type: string
- contextPath: Panorama.Services.SourcePort
description: The service source port.
type: string
- contextPath: Panorama.Services.DeviceGroup
description: The device group in which the service was configured (Panorama instances).
type: string
- contextPath: Panorama.Services.Tags
description: The service tags.
type: String
- arguments:
- description: The service name.
name: name
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
description: Returns service details for the supplied service name.
deprecated: true
name: panorama-get-service
outputs:
- contextPath: Panorama.Services.Name
description: The service name.
type: string
- contextPath: Panorama.Services.Protocol
description: The service protocol.
type: string
- contextPath: Panorama.Services.Description
description: The service description.
type: string
- contextPath: Panorama.Services.DestinationPort
description: The service destination port.
type: string
- contextPath: Panorama.Services.SourcePort
description: The service source port.
type: string
- contextPath: Panorama.Services.DeviceGroup
description: The device group for the service (Panorama instances).
type: string
- contextPath: Panorama.Service.Tags
description: The service tags.
type: String
- arguments:
- description: The name for the new service.
name: name
required: true
- auto: PREDEFINED
description: The protocol for the new service.
name: protocol
predefined:
- tcp
- udp
- sctp
required: true
- description: The destination port for the new service.
name: destination_port
required: true
- description: The source port for the new service.
name: source_port
- description: The description for the new service.
name: description
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tags for the new service.
isArray: true
name: tags
description: >
Creates a service.
Note: overrides the service if it already exists.
deprecated: true
name: panorama-create-service
outputs:
- contextPath: Panorama.Services.Name
description: The service name.
type: string
- contextPath: Panorama.Services.Protocol
description: The service protocol.
type: string
- contextPath: Panorama.Services.Descritpion
description: The service description.
type: string
- contextPath: Panorama.Services.DestinationPort
description: The service destination port.
type: string
- contextPath: Panorama.Services.SourcePort
description: The service source port.
type: string
- contextPath: Panorama.Services.DeviceGroup
description: The device group for the service (Panorama instances).
type: string
- contextPath: Panorama.Services.Tags
description: The service tags.
type: String
- arguments:
- description: The name of the service to delete.
name: name
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
description: Deletes a service.
deprecated: true
name: panorama-delete-service
outputs:
- contextPath: Panorama.Services.Name
description: The name of the deleted service.
type: string
- contextPath: Panorama.Services.DeviceGroup
description: The device group for the service (Panorama instances).
type: string
- arguments:
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tags for which to filter the service groups.
isArray: true
name: tag
description: Returns a list of service groups.
deprecated: true
name: panorama-list-service-groups
outputs:
- contextPath: Panorama.ServiceGroups.Name
description: The service group name.
type: string
- contextPath: Panorama.ServiceGroups.Services
description: The service group related services.
type: string
- contextPath: Panorama.ServiceGroups.DeviceGroup
description: The device group for the service group (Panorama instances).
type: string
- contextPath: Panorama.ServiceGroups.Tags
description: The service group tags.
type: String
- arguments:
- description: The service group name.
name: name
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
description: Returns details for the specified service group.
deprecated: true
name: panorama-get-service-group
outputs:
- contextPath: Panorama.ServiceGroups.Name
description: The service group name.
type: string
- contextPath: Panorama.ServiceGroups.Services
description: The service group related services.
type: string
- contextPath: Panorama.ServiceGroups.DeviceGroup
description: The device group for the service group (Panorama instances).
type: string
- contextPath: Panorama.ServiceGroups.Tags
description: The service group tags.
type: String
- arguments:
- description: The service group name.
name: name
required: true
- description: The service group related services.
isArray: true
name: services
required: true
- description: The device group for which to return addresses (Panorama instances).
name: device-group
- description: The tags for which to filter service groups.
isArray: true
name: tags
description: Creates a service group.
deprecated: true
name: panorama-create-service-group
outputs:
- contextPath: Panorama.ServiceGroups.Name
description: The service group name.
type: string
- contextPath: Panorama.ServiceGroups.Services
description: The service group related services.
type: string
- contextPath: Panorama.ServiceGroups.DeviceGroup
description: The device group for the service group (Panorama instances).
type: string
- contextPath: Panorama.ServiceGroups.Tags
description: The service group tags.
type: String
- arguments:
- description: The name of the service group to delete.