-
Notifications
You must be signed in to change notification settings - Fork 591
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
136 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
doc/manual/nasl/built-in-functions/description-functions/script_name.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# script_name | ||
|
||
## NAME | ||
|
||
**script_name** - sets the plugin's name. | ||
|
||
## SYNOPSIS | ||
|
||
*any* **script_name**(*string*); | ||
|
||
**script name** It takes an unnamed string argument. | ||
|
||
## DESCRIPTION | ||
|
||
The name can be change once the GVM versions older than GVM 11 (using VT name based preferences) reach the End of Life. | ||
|
||
|
||
## RETURN VALUE | ||
|
||
Returns nothing. | ||
|
||
## ERRORS | ||
|
||
|
||
## EXAMPLES | ||
|
||
**1**: | ||
```cpp | ||
script_name("Nmap (NASL wrapper)"); | ||
``` | ||
## SEE ALSO | ||
**[script_add_preference(3)](script_add_preference.md)**, **[script_copyright(3)](script_copyright.md)**, **[script_cve_id(3)](script_cve_id.md)**, **[script_dependencies(3)](script_dependencies.md)**, **[script_exclude_keys(3)](script_exclude_keys.md)**, **[script_mandatory_keys(3)](script_mandatory_keys.md)**, **[script_category(3)](script_category.md)**, **[script_family(3)](script_family.md)**, **[script_oid(3)](script_oid.md)**, **[script_require_keys(3)](script_require_keys.md)**, **[script_require_ports(3)](script_require_ports.md)**, **[script_require_udp_ports(3)](script_require_udp_ports.md)**, **[script_timeout(3)](script_timeout.md)**, **[script_version(3)](script_version.md)**, **[script_xref(3)](script_xref.md)**, **[script_tag(3)](script_tag.md)**, **[openvas-nasl(1)](../../openvas-nasl.md)** |
33 changes: 33 additions & 0 deletions
33
doc/manual/nasl/built-in-functions/description-functions/script_oid.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# script_oid | ||
|
||
## NAME | ||
|
||
**script_oid** - sets the plugin's oid. | ||
|
||
## SYNOPSIS | ||
|
||
*any* **script_oid**(*string*); | ||
|
||
**script oid** It takes one unnamed value. | ||
|
||
## DESCRIPTION | ||
|
||
Sets the plugin's oid. | ||
|
||
## RETURN VALUE | ||
|
||
Returns nothing. | ||
|
||
## ERRORS | ||
|
||
|
||
## EXAMPLES | ||
|
||
**1**: | ||
```cpp | ||
script_oid("1.3.6.1.4.1.25623.1.0.14259"); | ||
``` | ||
## SEE ALSO | ||
**[script_add_preference(3)](script_add_preference.md)**, **[script_copyright(3)](script_copyright.md)**, **[script_cve_id(3)](script_cve_id.md)**, **[script_dependencies(3)](script_dependencies.md)**, **[script_exclude_keys(3)](script_exclude_keys.md)**, **[script_mandatory_keys(3)](script_mandatory_keys.md)**, **[script_category(3)](script_category.md)**, **[script_family(3)](script_family.md)**, **[script_name(3)](script_name.md)**, **[script_require_keys(3)](script_require_keys.md)**, **[script_require_ports(3)](script_require_ports.md)**, **[script_require_udp_ports(3)](script_require_udp_ports.md)**, **[script_timeout(3)](script_timeout.md)**, **[script_version(3)](script_version.md)**, **[script_xref(3)](script_xref.md)**, **[script_tag(3)](script_tag.md)**, **[openvas-nasl(1)](../../openvas-nasl.md)** |
33 changes: 33 additions & 0 deletions
33
doc/manual/nasl/built-in-functions/description-functions/script_require_keys.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# script_require_keys | ||
|
||
## REQUIRE_KEYS | ||
|
||
**script_require_keys** - sets the list of “KB items” that must be set to run this script. | ||
|
||
## SYNOPSIS | ||
|
||
*any* **script_require_keys**(*string*, ...); | ||
|
||
**script require_keys** It takes any number of unnamed string arguments. | ||
|
||
## DESCRIPTION | ||
|
||
Sets the list of “KB items” that must be set to run this script. This only applies if the option “optimize_test” is "yes". | ||
|
||
## RETURN VALUE | ||
|
||
Returns nothing. | ||
|
||
## ERRORS | ||
|
||
|
||
## EXAMPLES | ||
|
||
**1**: | ||
```cpp | ||
script_require_keys("ftp/login"); | ||
``` | ||
## SEE ALSO | ||
**[script_add_preference(3)](script_add_preference.md)**, **[script_copyright(3)](script_copyright.md)**, **[script_cve_id(3)](script_cve_id.md)**, **[script_dependencies(3)](script_dependencies.md)**, **[script_exclude_keys(3)](script_exclude_keys.md)**, **[script_mandatory_keys(3)](script_mandatory_keys.md)**, **[script_category(3)](script_category.md)**, **[script_family(3)](script_family.md)**, **[script_oid(3)](script_oid.md)**, **[script_name(3)](script_name.md)**, **[script_require_ports(3)](script_require_ports.md)**, **[script_require_udp_ports(3)](script_require_udp_ports.md)**, **[script_timeout(3)](script_timeout.md)**, **[script_version(3)](script_version.md)**, **[script_xref(3)](script_xref.md)**, **[script_tag(3)](script_tag.md)**, **[openvas-nasl(1)](../../openvas-nasl.md)** |
33 changes: 33 additions & 0 deletions
33
doc/manual/nasl/built-in-functions/description-functions/script_require_ports.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# script_require_ports | ||
|
||
## REQUIRE_PORTS | ||
|
||
**script_require_ports** - sets the list of TCP ports that must be open to run this script in “optimize mode”. | ||
|
||
## SYNOPSIS | ||
|
||
*any* **script_require_ports**(*string*, ..., *int*); | ||
|
||
**script require_ports** It takes any number of unnamed integer or string arguments. | ||
|
||
## DESCRIPTION | ||
|
||
Sets the list of TCP ports that must be open to run this script in “optimize mode”. | ||
|
||
## RETURN VALUE | ||
|
||
Returns nothing. | ||
|
||
## ERRORS | ||
|
||
|
||
## EXAMPLES | ||
|
||
**1**: | ||
```cpp | ||
script_require_ports("ssh", 443); | ||
``` | ||
## SEE ALSO | ||
**[script_add_preference(3)](script_add_preference.md)**, **[script_copyright(3)](script_copyright.md)**, **[script_cve_id(3)](script_cve_id.md)**, **[script_dependencies(3)](script_dependencies.md)**, **[script_exclude_keys(3)](script_exclude_keys.md)**, **[script_mandatory_keys(3)](script_mandatory_keys.md)**, **[script_category(3)](script_category.md)**, **[script_family(3)](script_family.md)**, **[script_oid(3)](script_oid.md)**, **[script_name(3)](script_name.md)**, **[script_require_keys(3)](script_require_keys.md)**, **[script_require_udp_ports(3)](script_require_udp_ports.md)**, **[script_timeout(3)](script_timeout.md)**, **[script_version(3)](script_version.md)**, **[script_xref(3)](script_xref.md)**, **[script_tag(3)](script_tag.md)**, **[openvas-nasl(1)](../../openvas-nasl.md)** |