JSON RPC

Module description

LogDump - a subsystem that manages cluster dumps and logs

Operations

Delete Imports params

Context model: ImportParams

Request data

{
    "context": {
        "op": "import_param_del"
    }
}

Add Imports params

Context model: ImportParams

Request data

{
    "context": {
        "op": "import_param_add"
    },
    "data": {
        "pre_exec": "<pre_exec>",
        "post_exec": "<post_exec>"
    }
}

Description

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

Show Imports params

Context model: ImportParams

Request data

{
    "context": {
        "op": "import_param_show"
    }
}

Update Imports params

Context model: ImportParams

Request data

{
    "context": {
        "op": "import_param_update"
    },
    "data": {
        "pre_exec": "<pre_exec>",
        "post_exec": "<post_exec>"
    }
}

Description

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

Delete Exports params

Context model: ExportParams

Request data

{
    "context": {
        "op": "export_param_del"
    }
}

Add Exports params

Context model: ExportParams

Request data

{
    "context": {
        "op": "export_param_add"
    },
    "data": {
        "pre_exec": "<pre_exec>",
        "post_exec": "<post_exec>",
        "db": "<db>",
        "sosreport": "<sosreport>",
        "path": "<path>",
        "passwd": "<passwd>"
    }
}

Description

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

db [ str ] - Should DB state be exported? ['yes', 'no']

sosreport [ str ] - Should sosreport file be exported? ['yes', 'no']

path [ path ] - Path to the dir where the archive will be exported to

passwd [ str ] - Password for the exported archive

Show Exports params

Context model: ExportParams

Request data

{
    "context": {
        "op": "export_param_show"
    }
}

Update Exports params

Context model: ExportParams

Request data

{
    "context": {
        "op": "export_param_update"
    },
    "data": {
        "pre_exec": "<pre_exec>",
        "post_exec": "<post_exec>",
        "db": "<db>",
        "sosreport": "<sosreport>",
        "path": "<path>",
        "passwd": "<passwd>"
    }
}

Description

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

db [ str ] - Should DB state be exported? ['yes', 'no']

sosreport [ str ] - Should sosreport file be exported? ['yes', 'no']

path [ path ] - Path to the dir where the archive will be exported to

passwd [ str ] - Password for the exported archive

Clear import task

Context model: ImportsQ

Request data

{
    "context": {
        "op": "import_clear"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Task UUID

Add import task

Context model: ImportsQ

Request data

{
    "context": {
        "op": "import_add"
    },
    "data": {
        "node": "<node>",
        "pre_exec": "<pre_exec>",
        "post_exec": "<post_exec>",
        "zip": "<zip>"
    }
}

Description

node [ * required ] - Node names

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

zip [ ] - Zip file name

Show import task

Context model: ImportsQ

Request data

{
    "context": {
        "op": "import_show"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Task UUID

List all imports tasks

Context model: ImportsQ

Request data

{
    "context": {
        "op": "import_list"
    }
}

Clear export task

Context model: ExportsQ

Request data

{
    "context": {
        "op": "export_clear"
    },
    "data": {
        "uuid": "<uuid>",
        "node": "<node>"
    }
}

Description

uuid [ required ] - Task UUID

node [ ] - Node UUID

Add export task

Context model: ExportsQ

Request data

{
    "context": {
        "op": "export_add"
    },
    "data": {
        "node": "<node>",
        "pre_exec": "<pre_exec>",
        "post_exec": "<post_exec>",
        "db": "<db>",
        "sosreport": "<sosreport>",
        "path": "<path>",
        "passwd": "<passwd>",
        "delete_after": "<delete_after>"
    }
}

Description

node [ * required ] - Node names

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

db [ str ] - Should DB state be exported? ['yes', 'no']

sosreport [ str ] - Should sosreport file be exported? ['yes', 'no']

path [ path ] - Path to the dir where the archive will be exported to

passwd [ str ] - Password for the exported archive

delete_after [ date ] - Date or number of days after which the archive will be deleted

Show export task

Context model: ExportsQ

Request data

{
    "context": {
        "op": "export_show"
    },
    "data": {
        "uuid": "<uuid>",
        "node": "<node>"
    }
}

Description

uuid [ required ] - Task UUID

node [ ] - Node UUID

List all export tasks

Context model: ExportsQ

Request data

{
    "context": {
        "op": "export_list"
    }
}

trace

Request data

{
    "context": {
        "op": "trace"
    },
    "data": {
        "trace_token": "<trace_token>"
    }
}

Description

trace_token [ str required ] - trace_token

Models

ExportParams

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

db [ str ] - Should DB state be exported? ['yes', 'no']

sosreport [ str ] - Should sosreport file be exported? ['yes', 'no']

path [ path ] - Path to the dir where the archive will be exported to

passwd [ str ] - Password for the exported archive

delete_after [ date ] - Date or number of days after which the archive will be deleted

ImportParams

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

ExportsQ

uuid [ required ] - Task UUID

node [ * required ] - Node names

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands

db [ str ] - Should DB state be exported? ['yes', 'no']

sosreport [ str ] - Should sosreport file be exported? ['yes', 'no']

path [ path ] - Path to the dir where the archive will be exported to

passwd [ str ] - Password for the exported archive

delete_after [ date ] - Date or number of days after which the archive will be deleted

ImportsQ

uuid [ required ] - Task UUID

node [ * required ] - Node names

pre_exec [ * ] - List of pre commands

post_exec [ * ] - List of post commands