Skip to content

Commit

Permalink
docs(panos_security_rule): syntax update for lists in descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
alperenkose committed Sep 16, 2024
1 parent 8092af3 commit ddee190
Showing 1 changed file with 21 additions and 17 deletions.
38 changes: 21 additions & 17 deletions plugins/modules/panos_security_rule.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,17 @@
module: panos_security_rule
short_description: Manage security rule policy on PAN-OS devices or Panorama management console.
description: >
- Security policies allow you to enforce rules and take action, and can be as
general or specific as needed.
- The policy rules are compared against the incoming traffic in sequence, and
because the first rule that matches the traffic is applied, the more specific
rules must precede the more general ones.
- Defaults in spec descriptions apply when I(state=present)/I(state=replaced),
or when creating a new resource with I(state=merged).
Following rules apply for security policies:
- Security policies allow you to enforce rules and take action, and can be as
general or specific as needed.
- The policy rules are compared against the incoming traffic in sequence, and
because the first rule that matches the traffic is applied, the more specific
rules must precede the more general ones.
- Defaults in spec descriptions apply when I(state=present)/I(state=replaced),
or when creating a new resource with I(state=merged).
author:
- Ivan Bojer (@ivanbojer)
- Robert Hagen (@stealthllama)
Expand Down Expand Up @@ -78,18 +82,18 @@
type: list
elements: str
source_user:
description: >
description:
- Use users to enforce policy for individual users or a group of users.
Defaults to I(["any"]).
Defaults to I(["any"]).
type: list
elements: str
hip_profiles:
description: >
description:
- If you are using GlobalProtect with host information profile (HIP)
enabled, you can also base the policy on information collected by
GlobalProtect. For example, the user access level can be determined
HIP that notifies the firewall about the user's local configuration.
- NOTE: If I(state=present) or I(state=replaced), and you're running
- NOTE If I(state=present) or I(state=replaced), and you're running
PAN-OS < 10.0.0, then this will have a default of I(["any"]).
- If you are using PAN-OS >= 10.0.0, please do not use this
parameter as it was removed from PAN-OS in 10.0.0.
Expand All @@ -114,9 +118,9 @@
type: list
elements: str
application:
description: >
description:
- List of applications, application groups, and/or application filters.
Defaults to I(["any"]).
Defaults to I(["any"]).
type: list
elements: str
service:
Expand Down Expand Up @@ -194,14 +198,14 @@
- Send 'ICMP Unreachable'. Used with 'deny', 'drop', and 'reset' actions.
type: bool
disable_server_response_inspection:
description: >
description:
- Disables packet inspection from the server to the client. Useful under heavy server load conditions.
Defaults to I(false).
Defaults to I(false).
type: bool
group_profile:
description: >
description:
- Security profile group that is already defined in the system. This property supersedes antivirus,
vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties.
vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties.
type: str
antivirus:
description:
Expand Down

0 comments on commit ddee190

Please sign in to comment.