GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SEARCH::ELASTICSEARCH::CLIENT::1_0::DIRECT::SNAPSHOT (3)

.ds Aq ’

NAME

Search::Elasticsearch::Client::1_0::Direct::Snapshot - A client for managing snapshot/restore

CONTENTS

VERSION

version 2.00

DESCRIPTION

This module provides methods to manage snapshot/restore, or backups. It can create, get and delete configured backup repositories, and create, get, delete and restore snapshots of your cluster or indices.

It does Search::Elasticsearch::Role::Client::Direct.

METHODS

CWcreate_repository()



    $e->snapshot->create_repository(
        repository  => repository,        # required
        body        => { defn }             # required
    );



Create a repository for backups.

Query string parameters:
master_timeout,
timeout,
verify

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

CWget_repository()



    $e->snapshot->get_repository(
        repository  => repository | \@repositories    # optional
    );



Retrieve existing repositories.

Query string parameters:
local,
master_timeout

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

CWverify_repository()



    $e->snapshot->verify_repository(
        repository  => repository # required
    );



Verify existing repository.

Query string parameters:
master_timeout,
timeout

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

CWdelete_repository()



    $e->snapshot->delete_repository(
        repository  => repository | \@repositories    # required
    );



Delete repositories by name.

Query string parameters:
master_timeout,
timeout

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

CWcreate()



    $e->snapshot->create(
        repository  => repository,     # required
        snapshot    => snapshot,       # required,

        body        => { snapshot defn } # optional
    );



Create a snapshot of the whole cluster or individual indices in the named repository.

Query string parameters:
master_timeout,
wait_for_completion

CWget()



    $e->snapshot->get(
        repository  => repository                   # required
        snapshot    => snapshot   | \@snapshots     # required
    );



Retrieve snapshots in the named repository.

Query string parameters:
master_timeout

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

CWdelete()



    $e->snapshot->delete(
        repository  => repository,              # required
        snapshot    => snapshot                 # required
    );



Delete snapshot in the named repository.

Query string parameters:
master_timeout

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

CWrestore()



    $e->snapshot->restore(
        repository  => repository,              # required
        snapshot    => snapshot                 # required

        body        => { what to restore }        # optional
    );



Restore a named snapshot.

Query string parameters:
master_timeout,
wait_for_completion

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

CWstatus()



    $result = $e->snapshot->status(
        repository  => repository,              # optional
        snapshot    => snapshot | \@snapshots   # optional
    );



Returns status information about the specified snapshots.

Query string parameters:
master_timeout

See the snapshot/restore docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html> for more information.

AUTHOR

Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 by Elasticsearch BV.

This is free software, licensed under:



  The Apache License, Version 2.0, January 2004



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SEARCH::ELASTICSEARCH::CLIENT::1_0::DIRECT::SNAPSHOT (3) 2015-10-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.