class Parameter(Linkable):
id = fields.String(
description=(
"the Id of this action parameter (typically a concatenation of the parent "
"action Id with the parameter name)"
),
required=True,
example="folder-move",
)
number = fields.Integer(
description="the number of the parameter (starting from 0)", required=True, example=0
)
name = fields.String(
description="the name of the parameter", required=True, example="destination"
)
friendlyName = fields.String(
description="the action parameter name, formatted for rendering in a UI.",
required=True,
example="The destination folder id",
)
description = fields.String(
description="a description of the action parameter, e.g. to render as a tooltip.",
required=False,
example="The destination",
)
optional = fields.Boolean(
description="indicates whether the action parameter is optional",
required=False,
example=False,
)
# for string only
format = fields.String(
description=(
"for action parameters requiring a string or number value, indicates how to"
" interpret that value A2.5."
),
required=False,
)
maxLength = fields.Integer(
description=(
"for string action parameters, indicates the maximum allowable length. A "
"value of 0 means unlimited."
),
required=False,
)
pattern = fields.String(
description=(
"for string action parameters, indicates a regular expression for the "
"property to match."
),
required=False,
)
class ApiError(BaseSchema):
"""This is the base class for all API errors."""
code = fields.Integer(
description="The HTTP status code.",
required=True,
example=404,
)
message = fields.String(
description="Detailed information on what exactly went wrong.",
required=True,
example="The resource could not be found.",
)
title = fields.String(
description="A summary of the problem.",
required=True,
example="Not found",
)
_fields = fields.Dict(
data_key="fields", # mypy, due to attribute "fields" being used in marshmallow.Schema
keys=fields.String(description="The field name"),
values=fields.List(fields.String(description="The error messages")),
description="Detailed error messages on all fields failing validation.",
required=False,
)
ext: fields.Field = fields.Dict(
keys=fields.String(description="The key name"),
values=fields.String(description="The value"),
description="Additional information about the error.",
required=False,
)
class MovieSchema(Schema):
title = fields.String(required=True)
director = fields.String(required=True)
year = fields.Integer(required=True)
@post_load
def make_movie(self, data, **kwargs):
return Movie(**data)
class UserSchema(BaseSchema):
id = fields.Integer(dump_only=True)
name = fields.String(description="The user's name")
created = fields.DateTime(
dump_only=True,
format="iso8601",
dump_default=dt.datetime.utcnow,
doc_default="The current datetime",
)
class RuleExtensions(base.BaseSchema):
"""Serializes the 'extensions' part of the Rule Domain Object.
Examples:
>>> ext = RuleExtensions()
>>> from cmk.gui.utils.script_helpers import application_and_request_context
>>> with application_and_request_context():
... ext.load({
... 'folder': '/',
... })
{'folder': Folder('', 'Main')}
>>> with application_and_request_context():
... rv = ext.load({
... 'folder': '/',
... 'conditions': {
... 'service_description': {'match_on': ['foo'],
... 'operator': 'none_of',},
... 'host_tag': [{'key': 'criticality', 'operator': 'is', 'value': 'prod'}],
... }
... })
... rv
{'folder': Folder('', 'Main'), \
'conditions': {\
'host_tag': {'criticality': 'prod'},\
'service_description': {'$nor': [{'$regex': 'foo'}]}\
}}
>>> ext.dump(rv)
{'folder': '/', 'conditions': {\
'host_tag': [{'key': 'criticality', 'operator': 'is', 'value': 'prod'}], \
'service_description': {'match_on': ['foo'], 'operator': 'none_of'}}}
"""
cast_to_dict = True
ruleset = fields.String(description="The name of the ruleset.")
folder = gui_fields.FolderField(required=True, example="~router")
folder_index = fields.Integer(
description="The position of this rule in the chain in this folder.",
)
properties = fields.Nested(
RuleProperties,
description="Property values of this rule.",
example={},
)
value_raw = gui_fields.PythonString(
description="The raw parameter value for this rule.",
example='{"ignore_fs_types": ["tmpfs"]}',
)
conditions = fields.Nested(
RuleConditions,
description="Conditions.",
)
class RulesetExtensions(base.BaseSchema):
name = fields.String(
description="The name of the ruleset",
example="host_groups",
)
folder = gui_fields.FolderField(required=True, example="~router")
number_of_rules = fields.Integer(
description="The number of rules of this ruleset.",
example=5,
)
class UserIdleOption(BaseSchema):
option = fields.String(
required=True,
description="This field indicates if the idle timeout uses the global configuration, is "
"disabled or uses an individual duration",
enum=["global", "disable", "individual"],
)
duration = fields.Integer(
required=False,
description="The duration in seconds of the individual idle timeout if individual is "
"selected as idle timeout option.",
example=3600,
)
class BulkDiscovery(BaseSchema):
hostnames = fields.List(
EXISTING_HOST_NAME,
required=True,
example=["example", "sample"],
description="A list of host names",
)
mode = fields.String(
required=False,
description="""The mode of the discovery action. Can be one of:
* `new` - Add unmonitored services and new host labels
* `remove` - Remove vanished services
* `fix_all` - Add unmonitored services and new host labels, remove vanished services
* `refresh` - Refresh all services (tabula rasa), add new host labels
* `only_host_labels` - Only discover new host labels
""",
enum=list(DISCOVERY_ACTION.keys()),
example="refresh",
load_default="new",
)
do_full_scan = fields.Boolean(
required=False,
description="The option whether to perform a full scan or not.",
example=False,
load_default=True,
)
bulk_size = fields.Integer(
required=False,
description="The number of hosts to be handled at once.",
example=False,
load_default=10,
)
ignore_errors = fields.Boolean(
required=False,
description=
"The option whether to ignore errors in single check plugins.",
example=False,
load_default=True,
)
class ApiError(BaseSchema):
code = fields.Integer(
description="The HTTP status code.",
required=True,
example=404,
)
message = fields.String(
description="Detailed information on what exactly went wrong.",
required=True,
example="The resource could not be found.",
)
title = fields.String(
description="A summary of the problem.",
required=True,
example="Not found",
)
_fields = fields.Dict(
data_key="fields", # mypy
keys=fields.String(description="The field name"),
values=fields.List(fields.String(description="The error messages")),
description="Detailed error messages on all fields failing validation.",
required=False,
)
class IntegerDictSchema(ValueTypedDictSchema):
value_type = ValueTypedDictSchema.field(fields.Integer())
q = q.filter(
Downtimes.service_description.contains(service_description))
gen_downtimes = q.iterate(live)
return _serve_downtimes(gen_downtimes)
@Endpoint(
constructors.object_href("downtime", "{downtime_id}"),
"cmk/show",
method="get",
tag_group="Monitoring",
path_params=[{
"downtime_id":
fields.Integer(
description="The id of the downtime",
example="1",
)
}],
response_schema=response_schemas.DomainObject,
permissions_required=PERMISSIONS,
)
def show_downtime(params):
"""Show downtime"""
live = sites.live()
downtime_id = params["downtime_id"]
q = Query(
columns=[
Downtimes.id,
Downtimes.host_name,
Downtimes.service_description,
Downtimes.is_service,
