MapR 5.1 is at End of Life (EOL) and no longer supported. Please see the latest documentation. This documentation is not being updated.

Home
5.1 Reference
This section provides information about development content including MapR-FS and MapReduce development topics and reference content.
Reference Guide
maprcli and REST API Syntax
cluster
Manages cluster features, gateways, and cluster-wide settings.
cluster gateway list
Lists all of the gateways that a source MapR cluster is using.

MapR 5.1 Documentation

5.1 Reference
This section provides information about development content including MapR-FS and MapReduce development topics and reference content.
- Development Guide
- Reference Guide
  - MapR Control System
  - Hadoop Commands
  - HBase Shell for MapR-DB
    You can manage MapR-DB tables using HBase shell commands and additional HBase shell commands included in the MapR distribution of Hadoop.
  - YARN commands
  - maprcli and REST API Syntax
    - Overview
      Each command reference page includes the command syntax, a table that describes the parameters, and examples of command usage.
    - acl
      Describes the acl commands used to access control lists (ACLs).
    - alarm
      Describes the alarm commands that perform functions related to system alarms.
    - audit
      Describes commands used to audit operations related to cluster management and data access.
    - blacklist
      Describes commands used to blacklist and to list blacklisted users.
    - cluster
      Manages cluster features, gateways, and cluster-wide settings.
      - cluster feature enable
        Allows features to be enabled. Used after upgrading.
      - cluster feature list
        Allows features to be listed. Used after upgrading.
      - cluster gateway delete
        Deletes the list of MapR gateways from a source MapR cluster.
      - cluster gateway get
        Lists the MapR gateways that a source MapR cluster is using.
      - cluster gateway list
        Lists all of the gateways that a source MapR cluster is using.
      - cluster gateway local
        Lists the gateways that are configured on the MapR cluster where this command is run.
      - cluster gateway resolve
        Lists the gateways configured on MapR cluster that are up and running at the time that the command is issued.
      - cluster gateway set
        Specifies the locations of the MapR gateways that a source MapR cluster can use for table replication to a destination MapR cluster or for indexing table data in an Elasticsearch cluster.
      - cluster mapreduce get
        Displays the cluster-wide default for the MapReduce mode.
      - cluster mapreduce set
        Sets the cluster-wide MapReduce mode.
    - config
      Manages configuration values for the MapR cluster.
    - dashboard info
      Displays a summary of information about the cluster.
    - dialhome
    - disk
      Describes command for working with disks.
    - dump
      Returns key information about volumes, containers, storage pools, and MapR cluster services for debugging and troubleshooting.
    - entity
      Manages entities (users and groups).
    - fid
      Displays information about MapR-DB or file-system components that are identified by a FID.
    - job
      Manages Hadoop jobs running on the cluster.
    - license
      Manages MapR licenses.
    - nagios generate
      Generates a Nagios Object Definition file that describes the cluster nodes and the services running on each.
    - nfsmgmt
      Refreshes NFS exports and server cache.
    - node
      Manages nodes in the cluster
    - rlimit
      Manages resource usage limits for the cluster.
    - schedule
      Manages schedules.
    - service list
      Lists all services on the specified node, the memory allocated for each service, the state of each service, and log path for each service.
    - setloglevel
      Sets log level on individual services.
    - stream
      Manages stream functionality.
    - table
      Performs functions related to MapR-DB tables.
    - task
      Manipulates information about the Hadoop jobs that are running on your cluster.
    - trace
      Lets you view and modify the trace buffer, and the trace levels for the system modules.
    - urls
      Displays the status page URL for the specified service.
    - virtualip
      Manages virtual IP addresses for NFS nodes.
    - volume
      Manages volumes, snapshots and mirrors.
  - Alarms Reference
  - Utilities
  - Default MapR Configurations
  - Configuration Files
  - MapR Environment
  - MapR Parameters
  - Best Practices
  - Language Support for MapR-DB Tables
  - Glossary
    This section contains defintions for commonly used terms in MapR Converged Data Platform environments.
  - Source Code for MapR Software
- Glossary
  This section contains defintions for commonly used terms in MapR Converged Data Platform environments.

cluster gateway list

Lists all of the gateways that a source MapR cluster is using.

The source MapR cluster is using gateways either for replication of table data to destination MapR clusters or for the indexing of table data in Elasticsearch clusters.

This list is created by the maprcli cluster gateway set command.

Syntax

CLI: maprcli cluster gateway list [ -cluster sourceCluster]
REST: http[s]://<host>:<port>/rest/cluster/gateway/list

Parameters

Parameter	Description
cluster	If you are not on the source cluster, provide the name of the source cluster that this command should be run on.

Example

Lists all the gateways that a source MapR cluster can use when replicating table data in MapR clusters or indexing data in Elasticsearch clusters. In this example, supposing newyork to be the name of a MapR cluster that is a destination for table replication, the output shows two gateways that are available for replicating to this cluster.

CLI

maprcli cluster gateway list

REST

https://<host>:<port>/rest/cluster/gateway/list

Example Output

cluster    gatewayConfig
newyork  gw1 gw2