Skip to content

Commit ddee190

Browse files
committed
docs(panos_security_rule): syntax update for lists in descriptions
1 parent 8092af3 commit ddee190

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

plugins/modules/panos_security_rule.py

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,17 @@
2424
module: panos_security_rule
2525
short_description: Manage security rule policy on PAN-OS devices or Panorama management console.
2626
description: >
27-
- Security policies allow you to enforce rules and take action, and can be as
28-
general or specific as needed.
29-
- The policy rules are compared against the incoming traffic in sequence, and
30-
because the first rule that matches the traffic is applied, the more specific
31-
rules must precede the more general ones.
32-
- Defaults in spec descriptions apply when I(state=present)/I(state=replaced),
33-
or when creating a new resource with I(state=merged).
27+
Following rules apply for security policies:
28+
29+
- Security policies allow you to enforce rules and take action, and can be as
30+
general or specific as needed.
31+
32+
- The policy rules are compared against the incoming traffic in sequence, and
33+
because the first rule that matches the traffic is applied, the more specific
34+
rules must precede the more general ones.
35+
36+
- Defaults in spec descriptions apply when I(state=present)/I(state=replaced),
37+
or when creating a new resource with I(state=merged).
3438
author:
3539
- Ivan Bojer (@ivanbojer)
3640
- Robert Hagen (@stealthllama)
@@ -78,18 +82,18 @@
7882
type: list
7983
elements: str
8084
source_user:
81-
description: >
85+
description:
8286
- Use users to enforce policy for individual users or a group of users.
83-
Defaults to I(["any"]).
87+
Defaults to I(["any"]).
8488
type: list
8589
elements: str
8690
hip_profiles:
87-
description: >
91+
description:
8892
- If you are using GlobalProtect with host information profile (HIP)
8993
enabled, you can also base the policy on information collected by
9094
GlobalProtect. For example, the user access level can be determined
9195
HIP that notifies the firewall about the user's local configuration.
92-
- NOTE: If I(state=present) or I(state=replaced), and you're running
96+
- NOTE If I(state=present) or I(state=replaced), and you're running
9397
PAN-OS < 10.0.0, then this will have a default of I(["any"]).
9498
- If you are using PAN-OS >= 10.0.0, please do not use this
9599
parameter as it was removed from PAN-OS in 10.0.0.
@@ -114,9 +118,9 @@
114118
type: list
115119
elements: str
116120
application:
117-
description: >
121+
description:
118122
- List of applications, application groups, and/or application filters.
119-
Defaults to I(["any"]).
123+
Defaults to I(["any"]).
120124
type: list
121125
elements: str
122126
service:
@@ -194,14 +198,14 @@
194198
- Send 'ICMP Unreachable'. Used with 'deny', 'drop', and 'reset' actions.
195199
type: bool
196200
disable_server_response_inspection:
197-
description: >
201+
description:
198202
- Disables packet inspection from the server to the client. Useful under heavy server load conditions.
199-
Defaults to I(false).
203+
Defaults to I(false).
200204
type: bool
201205
group_profile:
202-
description: >
206+
description:
203207
- Security profile group that is already defined in the system. This property supersedes antivirus,
204-
vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties.
208+
vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties.
205209
type: str
206210
antivirus:
207211
description:

0 commit comments

Comments
 (0)