Skip to content

Commit ab125c2

Browse files
chkp-majdschkp-majds
authored
Merge pull request #21 from chkp-ameera/master
update facts docs
2 parents 114f5c5 + a4e56b4 commit ab125c2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1722
-126
lines changed

‎.github/workflows/ansible-test.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ jobs:
2929
ansible:
3030
# It's important that Sanity is tested against all stable-X.Y branches
3131
# Testing against `devel` may fail as new tests are added.
32+
- stable-2.9
33+
- stable-2.10
3234
- stable-2.11
3335
- stable-2.12
3436
- stable-2.13

‎plugins/modules/cp_gaia_allowed_clients_facts.py

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,34 @@
4444

4545
RETURN = """
4646
ansible_facts:
47-
description: The checkpoint object facts.
48-
returned: always.
49-
type: dict
47+
description: The checkpoint object facts.
48+
returned: always.
49+
type: dict
50+
contains:
51+
allowed_any_host:
52+
description:
53+
- Allowed any host to access the server.
54+
returned: always
55+
type: bool
56+
allowed_hosts:
57+
description:
58+
- Lists of allowed hosts.
59+
returned: always
60+
type: list
61+
elements: str
62+
allowed_networks:
63+
description:
64+
- List of allowed networks.
65+
returned: always
66+
type: list
67+
elements: dict
68+
contains:
69+
subnet:
70+
description: The network subnet.
71+
type: str
72+
mask_length:
73+
description: The network mask length.
74+
type: int
5075
"""
5176

5277

‎plugins/modules/cp_gaia_api_versions_facts.py

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,21 @@
4141

4242
RETURN = """
4343
ansible_facts:
44-
description: The api versions facts.
45-
returned: always.
46-
type: list
44+
description: The api versions facts.
45+
returned: always.
46+
type: dict
47+
contains:
48+
current_version:
49+
description:
50+
- Represents the latest supported version by the installed REST engine.
51+
returned: always
52+
type: str
53+
supported_versions:
54+
description:
55+
- Represents all the previous versions supported by the installed REST engine.
56+
returned: always
57+
type: list
58+
elements: str
4759
"""
4860

4961
from ansible.module_utils.basic import AnsibleModule

‎plugins/modules/cp_gaia_asset_facts.py

Lines changed: 108 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,114 @@
4141

4242
RETURN = """
4343
ansible_facts:
44-
description: The asset facts.
45-
returned: always.
46-
type: list
44+
description: The asset facts.
45+
returned: always.
46+
type: dict
47+
contains:
48+
ac:
49+
description:
50+
- The AC asset.
51+
returned: always
52+
type: list
53+
elements: dict
54+
contains:
55+
key:
56+
description: The asset element key.
57+
type: str
58+
value:
59+
description: The asset element value.
60+
type: str
61+
disk:
62+
description:
63+
- The disk asset.
64+
returned: always
65+
type: list
66+
elements: dict
67+
contains:
68+
key:
69+
description: The asset element key.
70+
type: str
71+
value:
72+
description: The asset element value.
73+
type: str
74+
lom_info:
75+
description:
76+
- The lom asset.
77+
returned: always
78+
type: list
79+
elements: dict
80+
contains:
81+
key:
82+
description: The asset element key.
83+
type: str
84+
value:
85+
description: The asset element value.
86+
type: str
87+
memory:
88+
description:
89+
- The memory asset.
90+
returned: always
91+
type: list
92+
elements: dict
93+
contains:
94+
key:
95+
description: The asset element key.
96+
type: str
97+
value:
98+
description: The asset element value.
99+
type: str
100+
network:
101+
description:
102+
- The network asset.
103+
returned: always
104+
type: list
105+
elements: dict
106+
contains:
107+
key:
108+
description: The asset element key.
109+
type: str
110+
value:
111+
description: The asset element value.
112+
type: str
113+
power_supply:
114+
description:
115+
- The power supply asset.
116+
returned: always
117+
type: list
118+
elements: dict
119+
contains:
120+
key:
121+
description: The asset element key.
122+
type: str
123+
value:
124+
description: The asset element value.
125+
type: str
126+
sam:
127+
description:
128+
- The sam asset.
129+
returned: always
130+
type: list
131+
elements: dict
132+
contains:
133+
key:
134+
description: The asset element key.
135+
type: str
136+
value:
137+
description: The asset element value.
138+
type: str
139+
system:
140+
description:
141+
- The system asset.
142+
returned: always
143+
type: list
144+
elements: dict
145+
contains:
146+
key:
147+
description: The asset element key.
148+
type: str
149+
value:
150+
description: The asset element value.
151+
type: str
47152
"""
48153

49154
from ansible.module_utils.basic import AnsibleModule

‎plugins/modules/cp_gaia_banner_facts.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,20 @@
4242

4343
RETURN = """
4444
ansible_facts:
45-
description: The checkpoint object facts.
46-
returned: always.
47-
type: dict
45+
description: The checkpoint object facts.
46+
returned: always.
47+
type: dict
48+
contains:
49+
message:
50+
description:
51+
- Banner message.
52+
returned: always
53+
type: str
54+
enabled:
55+
description:
56+
- If banner enabled.
57+
returned: always
58+
type: bool
4859
"""
4960

5061
from ansible.module_utils.basic import AnsibleModule

‎plugins/modules/cp_gaia_bond_interface_facts.py

Lines changed: 153 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,159 @@
5050

5151
RETURN = """
5252
ansible_facts:
53-
description: The interface/s facts.
54-
returned: always.
55-
type: list
53+
description: The interface/s facts.
54+
returned: always.
55+
type: dict
56+
contains:
57+
objects:
58+
description:
59+
- List of interfaces.
60+
returned: always
61+
type: list
62+
elements: dict
63+
contains:
64+
name:
65+
description:
66+
- Interface name.
67+
returned: always
68+
type: str
69+
ipv4_address:
70+
description: Interface IPv4 address.
71+
returned: always
72+
type: str
73+
ipv4_mask_length:
74+
description: Interface IPv4 address mask length.
75+
returned: always
76+
type: int
77+
ipv6_address:
78+
description: Interface IPv6 address.
79+
returned: always
80+
type: str
81+
ipv6_autoconfig:
82+
description: Configure IPv6 auto-configuration.
83+
returned: always
84+
type: bool
85+
ipv6_mask_length:
86+
description: Interface IPv6 address mask length.
87+
returned: always
88+
type: int
89+
comments:
90+
description: Interface Comments.
91+
returned: always
92+
type: str
93+
enabled:
94+
description: Interface State.
95+
returned: always
96+
type: bool
97+
dhcp:
98+
description: DHCP configuration.
99+
returned: always
100+
type: dict
101+
contains:
102+
enabled:
103+
description: Enable DHCP on this interface.
104+
returned: always
105+
type: bool
106+
server_timeout:
107+
description: Specifies the amount of time, in seconds,
108+
that must pass between the time that the interface begins to try to determine its address
109+
and the time that it decides that it's not going to be able to contact a server.
110+
returned: always
111+
type: int
112+
retry:
113+
description: Specifies the time, in seconds,
114+
that must pass after the interface has determined that there is no DHCP server present
115+
before it tries again to contact a DHCP server.
116+
returned: always
117+
type: int
118+
leasetime:
119+
description:
120+
- Specifies the lease time, in seconds, when requesting for an IP address.
121+
Default value is "default" - according to the server.
122+
returned: always
123+
type: int
124+
reacquire_timeout:
125+
description:
126+
- When trying to reacquire the last ip address,
127+
The reacquire-timeout statement sets the time, in seconds,
128+
that must elapse after the first try to reacquire the old address before it gives up and
129+
tries to discover a new address.
130+
returned: always
131+
type: int
132+
mtu:
133+
description: Interface mtu.
134+
returned: always
135+
type: int
136+
ipv6_local_link_address:
137+
description: Interface ipv6 local link address.
138+
returned: always
139+
type: str
140+
status:
141+
description: Interface data.
142+
returned: always
143+
type: dict
144+
contains:
145+
link_state:
146+
description: Link status.
147+
returned: always
148+
type: bool
149+
speed:
150+
description: Speed.
151+
returned: always
152+
type: str
153+
duplex:
154+
description: Duplex.
155+
returned: always
156+
type: str
157+
tx_bytes:
158+
description: TX bytes.
159+
returned: always
160+
type: int
161+
tx_packets:
162+
description: TX packets.
163+
returned: always
164+
type: int
165+
rx_bytes:
166+
description: RX bytes.
167+
returned: always
168+
type: int
169+
rx_packets:
170+
description: RX packets.
171+
returned: always
172+
type: int
173+
members:
174+
description: Interfaces members of the bond.
175+
returned: always
176+
type: list
177+
elements: str
178+
xmit_hash_policy:
179+
description: Transmit hash policy.
180+
returned: always
181+
type: str
182+
down_delay:
183+
description: Down delay in milliseconds.
184+
returned: always
185+
type: int
186+
up_delay:
187+
description: Up delay in milliseconds.
188+
returned: always
189+
type: int
190+
primary:
191+
description: Primary member of the bond interface.
192+
returned: always
193+
type: str
194+
lacp_rate:
195+
description: LACP rate.
196+
returned: always
197+
type: str
198+
mode:
199+
description: Primary member of the bond interface.
200+
returned: always
201+
type: str
202+
mii_interval:
203+
description: Media monitoring interval, Valid values are C(1-5000).
204+
returned: always
205+
type: int
56206
"""
57207

58208
from ansible.module_utils.basic import AnsibleModule

0 commit comments

Comments
 (0)