[email protected] Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of srm-api Show documentation
There is a newer version: 0.14.1
module odl-srm-rpcs {
    namespace "urn:opendaylight:serviceutils:srm:rpc";
    prefix "srmrpc";

    import odl-srm-types {
        prefix srmtype;
    }

    revision "2018-06-26" {
        description "ODL Services Recovery Manager Rpcs Module";
    }

    /* RPCs */

    rpc reinstall {
        description "Reinstall a given service";
        input {
            leaf entity-name {
                type identityref {
                    base srmtype:entity-name-base;
                }
            }
            leaf entity-type {
                description "Currently supported entity-types:
                                service";
                type identityref {
                    base srmtype:entity-type-base;
                }
            }
        }
        output {
            leaf successful {
                type boolean;
            }
            leaf message {
                type string;
            }
        }
    }


    rpc recover {
        description "Recover a given service or instance";
        input {
            leaf entity-name {
                type identityref {
                    base srmtype:entity-name-base;
                }
            }
            leaf entity-type {
                description "Currently supported entity-types:
                                service, instance";
                type identityref {
                    base srmtype:entity-type-base;
                }
            }
            leaf entity-id {
                description "Optional when entity-type is service. Actual
                             id depends on entity-type and entity-name";
                type string;
            }
        }
        output {
            leaf response {
                type identityref {
                    base rpc-result-base;
                }
            }
            leaf message {
                type string;
            }
        }
    }

    /* RPC RESULTs */

    identity rpc-result-base {
        description "Base identity for all SRM RPC Results";
    }
    identity rpc-success {
        description "RPC result successful";
        base rpc-result-base;
    }
    identity rpc-fail-op-not-supported {
        description "RPC failed:
                        operation not supported for given parameters";
        base rpc-result-base;
    }
    identity rpc-fail-entity-type {
        description "RPC failed:
                        invalid entity type";
        base rpc-result-base;
    }
    identity rpc-fail-entity-name {
        description "RPC failed:
                        invalid entity name";
        base rpc-result-base;
    }
    identity rpc-fail-entity-id {
        description "RPC failed:
                        invalid entity id";
        base rpc-result-base;
    }
    identity rpc-fail-unknown {
        description "RPC failed:
                        reason not known, check message string for details";
        base rpc-result-base;
    }
}